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 <cstring> // for strcmp
25 #include <dali/public-api/common/dali-common.h>
26 #include <dali/public-api/object/type-registry.h>
27 #include <dali/internal/event/common/event-thread-services.h>
28 #include <dali/internal/event/actors/actor-impl.h>
29 #include <dali/internal/event/actors/camera-actor-impl.h>
30 #include <dali/internal/event/common/property-helper.h>
31 #include <dali/internal/event/common/stage-impl.h>
32 #include <dali/internal/event/images/frame-buffer-image-impl.h>
33 #include <dali/internal/update/nodes/node.h>
34 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
35 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
37 #if defined(DEBUG_ENABLED)
40 Debug::Filter* gLogRender = Debug::Filter::New(Debug::Concise, false, "LOG_RENDER_TASK");
50 namespace // For internal properties
55 // Name Type writable animatable constraint-input enum for index-checking
56 DALI_PROPERTY_TABLE_BEGIN
57 DALI_PROPERTY( "viewport-position", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_POSITION )
58 DALI_PROPERTY( "viewport-size", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_SIZE )
59 DALI_PROPERTY( "clear-color", VECTOR4, true, true, true, Dali::RenderTask::Property::CLEAR_COLOR )
60 DALI_PROPERTY_TABLE_END( DEFAULT_OBJECT_PROPERTY_START_INDEX )
64 const char* const SIGNAL_FINISHED = "finished";
66 TypeRegistration mType( typeid( Dali::RenderTask ), typeid( Dali::BaseHandle ), NULL );
68 SignalConnectorType signalConnector1( mType, SIGNAL_FINISHED, &RenderTask::DoConnectSignal );
70 } // Unnamed namespace
72 RenderTask* RenderTask::New( bool isSystemLevel )
74 RenderTask* task( new RenderTask( isSystemLevel ) );
79 void RenderTask::SetSourceActor( Actor* actor )
81 const Stage* stage = Stage::GetCurrent();
84 stage->GetRenderTaskList().SetExclusive( this, mExclusive );
86 mSourceConnector.SetActor( actor );
89 Actor* RenderTask::GetSourceActor() const
91 return mSourceConnector.mActor;
94 void RenderTask::SetExclusive( bool exclusive )
96 if ( mExclusive != exclusive )
98 mExclusive = exclusive;
100 const Stage* stage = Stage::GetCurrent();
103 stage->GetRenderTaskList().SetExclusive( this, exclusive );
108 // mSceneObject is being used in a separate thread; queue a message to set the value
109 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
114 bool RenderTask::IsExclusive() const
119 void RenderTask::SetInputEnabled( bool enabled )
121 mInputEnabled = enabled;
124 bool RenderTask::GetInputEnabled() const
126 return mInputEnabled;
129 void RenderTask::SetCameraActor( CameraActor* cameraActor )
131 mCameraConnector.SetActor( cameraActor );
134 CameraActor* RenderTask::GetCameraActor() const
136 // camera connector can only point to camera actor
137 return static_cast< CameraActor* >( mCameraConnector.mActor );
140 void RenderTask::SetTargetFrameBuffer( Dali::FrameBufferImage image )
142 if ( mFrameBufferImage != image )
144 // if we have a scene object we need to track connection status and set frame buffer id as well as updating target frame buffer
147 if(mFrameBufferImage)
149 GetImplementation(mFrameBufferImage).Disconnect();
152 // update target frame buffer
153 mFrameBufferImage = image;
155 unsigned int resourceId = 0;
156 if(mFrameBufferImage)
158 GetImplementation(mFrameBufferImage).Connect();
160 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
163 // mSceneObject is being used in a separate thread; queue a message to set the value
164 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
168 // update target frame buffer
169 mFrameBufferImage = image;
174 Dali::FrameBufferImage RenderTask::GetTargetFrameBuffer() const
176 return mFrameBufferImage;
179 void RenderTask::SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction )
181 mScreenToFrameBufferFunction = conversionFunction;
184 RenderTask::ScreenToFrameBufferFunction RenderTask::GetScreenToFrameBufferFunction() const
186 return mScreenToFrameBufferFunction;
189 void RenderTask::SetScreenToFrameBufferMappingActor( Actor* mappingActor )
191 mMappingConnector.SetActor( mappingActor );
194 Actor* RenderTask::GetScreenToFrameBufferMappingActor() const
196 return mMappingConnector.mActor;
199 void RenderTask::SetViewportPosition(const Vector2& value)
201 BakeViewportPositionMessage( GetEventThreadServices(), *mSceneObject, value );
204 Vector2 RenderTask::GetCurrentViewportPosition() const
206 return mSceneObject->GetViewportPosition( GetEventThreadServices().GetEventBufferIndex() );
209 void RenderTask::SetViewportSize(const Vector2& value)
211 BakeViewportSizeMessage( GetEventThreadServices(), *mSceneObject, value );
214 Vector2 RenderTask::GetCurrentViewportSize() const
216 return mSceneObject->GetViewportSize( GetEventThreadServices().GetEventBufferIndex() );
219 void RenderTask::SetViewport( const Viewport& viewport )
221 SetViewportPosition(Vector2(viewport.x, viewport.y));
222 SetViewportSize(Vector2(viewport.width, viewport.height));
225 void RenderTask::GetViewport( Viewport& viewPort ) const
227 BufferIndex bufferIndex = GetEventThreadServices().GetEventBufferIndex();
229 if(!mSceneObject->GetViewportEnabled( bufferIndex ))
231 if ( mFrameBufferImage )
233 viewPort.x = viewPort.y = 0;
234 viewPort.width = mFrameBufferImage.GetWidth();
235 viewPort.height = mFrameBufferImage.GetHeight();
239 Vector2 size( Stage::GetCurrent()->GetSize() );
240 viewPort.x = viewPort.y = 0;
241 viewPort.width = size.width;
242 viewPort.height = size.height;
247 const Vector2& position = mSceneObject->GetViewportPosition(bufferIndex);
248 const Vector2& size = mSceneObject->GetViewportSize(bufferIndex);
249 viewPort.x = position.x;
250 viewPort.y = position.y;
251 viewPort.width = size.width;
252 viewPort.height = size.height;
256 void RenderTask::SetClearColor( const Vector4& color )
258 if ( mClearColor != color )
264 // mSceneObject is being used in a separate thread; queue a message to set the value
265 BakeClearColorMessage( GetEventThreadServices(), *mSceneObject, color );
270 const Vector4& RenderTask::GetClearColor() const
272 return mSceneObject->GetClearColor( GetEventThreadServices().GetEventBufferIndex() );
275 void RenderTask::SetClearEnabled( bool enabled )
277 if ( mClearEnabled != enabled )
279 mClearEnabled = enabled;
283 // mSceneObject is being used in a separate thread; queue a message to set the value
284 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
289 bool RenderTask::GetClearEnabled() const
291 return mClearEnabled;
294 void RenderTask::SetCullMode( bool mode )
296 if ( mCullMode != mode )
302 // mSceneObject is being used in a separate thread; queue a message to set the value
303 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
308 bool RenderTask::GetCullMode() const
313 void RenderTask::SetRefreshRate( unsigned int refreshRate )
315 DALI_LOG_TRACE_METHOD_FMT(gLogRender, "this:%p rate:%d\n", this, refreshRate);
316 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::SetRefreshRate(this:%p, %d)\n", this, refreshRate);
318 mRefreshRate = refreshRate; // cached for GetRefreshRate()
320 // Note - even when refreshRate is the same as mRefreshRate, a message should be sent
324 // mSceneObject is being used in a separate thread; queue a message to set the value
325 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, refreshRate );
329 unsigned int RenderTask::GetRefreshRate() const
334 bool RenderTask::IsHittable( Vector2& screenCoords ) const
336 // True when input is enabled, source & camera actor are valid
337 bool inputEnabled( false );
339 Actor* sourceActor = GetSourceActor();
340 CameraActor* cameraActor = GetCameraActor();
342 if ( mInputEnabled &&
343 NULL != sourceActor &&
344 sourceActor->OnStage() &&
345 NULL != cameraActor &&
346 cameraActor->OnStage() )
348 // If the actors are rendered off-screen, then the screen coordinates must be converted
349 // and the conversion function will tell us if they are inside or outside
350 if ( TranslateCoordinates( screenCoords ) )
352 // This is a suitable render-task for input handling
360 bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
362 // return true for on-screen tasks
364 // If the actors are rendered off-screen, then the screen coordinates must be converted
365 // the function should only be called for offscreen tasks
366 if( mFrameBufferImage && mMappingConnector.mActor )
368 CameraActor* localCamera = GetCameraActor();
369 StagePtr stage = Stage::GetCurrent();
370 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
374 Vector2 size( stage->GetSize() );
375 viewport.x = viewport.y = 0;
376 viewport.width = size.width;
377 viewport.height = size.height;
379 float localX, localY;
380 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
381 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
382 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
384 screenCoords.x = localX;
385 screenCoords.y = localY;
397 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
399 inside = mScreenToFrameBufferFunction( screenCoords );
404 bool RenderTask::IsSystemLevel() const
406 return mIsSystemLevel;
409 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
411 // This should only be called once, with no existing scene-object
412 DALI_ASSERT_DEBUG( NULL == mSceneObject );
414 // Keep the raw-pointer until DiscardSceneObject is called
415 mSceneObject = SceneGraph::RenderTask::New();
417 // 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
418 unsigned int resourceId = 0;
419 if(mFrameBufferImage)
421 GetImplementation(mFrameBufferImage).Connect();
423 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
426 // mSceneObject is being used in a separate thread; queue a message to set the value
427 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
429 // Send messages to set other properties that may have changed since last time we were on stage
430 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
431 SetClearColorMessage( GetEventThreadServices(), *mSceneObject, mClearColor );
432 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
433 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
434 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, mRefreshRate );
436 // Caller takes ownership
440 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
445 void RenderTask::DiscardSceneObject()
447 // mSceneObject is not owned; throw away the raw-pointer
450 // if we have a frame buffer we need to track connection status
451 if(mFrameBufferImage)
453 GetImplementation(mFrameBufferImage).Disconnect();
457 /********************************************************************************
458 ******************************** PROPERTY METHODS **************************
459 ********************************************************************************/
461 unsigned int RenderTask::GetDefaultPropertyCount() const
463 return DEFAULT_PROPERTY_COUNT;
466 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
468 indices.Reserve( DEFAULT_PROPERTY_COUNT );
470 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
472 indices.PushBack( i );
476 const char* RenderTask::GetDefaultPropertyName( Property::Index index ) const
478 if( index < DEFAULT_PROPERTY_COUNT )
480 return DEFAULT_PROPERTY_DETAILS[index].name;
488 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
490 Property::Index index = Property::INVALID_INDEX;
492 // Look for name in default properties
493 for( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
495 if( 0 == strcmp( name.c_str(), DEFAULT_PROPERTY_DETAILS[i].name ) ) // dont want to convert rhs to string
505 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
507 return DEFAULT_PROPERTY_DETAILS[ index ].writable;
510 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
512 return DEFAULT_PROPERTY_DETAILS[ index ].animatable;
515 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
517 return DEFAULT_PROPERTY_DETAILS[ index ].constraintInput;
520 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
522 if( index < DEFAULT_PROPERTY_COUNT )
524 return DEFAULT_PROPERTY_DETAILS[index].type;
527 // index out of range...return Property::NONE
528 return Property::NONE;
531 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
535 case Dali::RenderTask::Property::VIEWPORT_POSITION:
537 SetViewportPosition( property.Get<Vector2>() );
540 case Dali::RenderTask::Property::VIEWPORT_SIZE:
542 SetViewportSize( property.Get<Vector2>() );
545 case Dali::RenderTask::Property::CLEAR_COLOR:
547 SetClearColor( property.Get<Vector4>() );
558 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
560 Property::Value value;
565 case Dali::RenderTask::Property::VIEWPORT_POSITION:
567 value = GetCurrentViewportPosition();
570 case Dali::RenderTask::Property::VIEWPORT_SIZE:
572 value = GetCurrentViewportSize();
575 case Dali::RenderTask::Property::CLEAR_COLOR:
577 value = GetClearColor();
583 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
591 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
596 const SceneGraph::PropertyBase* RenderTask::GetSceneObjectAnimatableProperty( Property::Index index ) const
598 DALI_ASSERT_ALWAYS( IsPropertyAnimatable(index) && "Property is not animatable" );
600 const SceneGraph::PropertyBase* property( NULL );
602 // This method should only return a property which is part of the scene-graph
603 if( mSceneObject != NULL )
607 case Dali::RenderTask::Property::VIEWPORT_POSITION:
608 property = &mSceneObject->mViewportPosition;
611 case Dali::RenderTask::Property::VIEWPORT_SIZE:
612 property = &mSceneObject->mViewportSize;
615 case Dali::RenderTask::Property::CLEAR_COLOR:
616 property = &mSceneObject->mClearColor;
627 const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Index index ) const
629 const PropertyInputImpl* property( NULL );
630 if( mSceneObject != NULL )
634 case Dali::RenderTask::Property::VIEWPORT_POSITION:
635 property = &mSceneObject->mViewportPosition;
638 case Dali::RenderTask::Property::VIEWPORT_SIZE:
639 property = &mSceneObject->mViewportSize;
642 case Dali::RenderTask::Property::CLEAR_COLOR:
643 property = &mSceneObject->mViewportSize;
654 bool RenderTask::HasFinished()
656 bool finished = false;
657 const unsigned int counter = mSceneObject->GetRenderedOnceCounter();
659 if( mRefreshOnceCounter < counter )
662 mRefreshOnceCounter = counter;
665 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::HasFinished()=%s SCRT:%p SC\n", finished?"T":"F", mSceneObject);
670 void RenderTask::EmitSignalFinish()
672 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::EmitSignalFinish(this:%p)\n", this);
674 if( !mSignalFinished.Empty() )
676 Dali::RenderTask handle( this );
677 mSignalFinished.Emit(handle );
681 Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
683 return mSignalFinished;
686 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
688 bool connected( true );
689 RenderTask* renderTask = dynamic_cast<RenderTask*>(object);
691 if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
693 renderTask->FinishedSignal().Connect( tracker, functor );
697 // signalName does not match any signal
704 RenderTask::RenderTask( bool isSystemLevel )
705 : mSceneObject( NULL ),
706 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
707 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
708 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
709 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
710 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
711 mRefreshOnceCounter( 0u ),
712 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
713 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
714 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
715 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
716 mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
717 mIsSystemLevel( isSystemLevel )
719 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
722 RenderTask::~RenderTask()
724 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::~RenderTask(this:%p)\n", this);
727 // Helper class for connecting Nodes to the scene-graph RenderTask
729 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
731 mRenderTask( renderTask ),
736 RenderTask::Connector::~Connector()
741 void RenderTask::Connector::SetActor( Actor* actor )
743 if ( mActor != actor )
747 mActor->RemoveObserver( *this );
754 mActor->AddObserver( *this );
761 void RenderTask::Connector::SceneObjectAdded( Object& object )
766 void RenderTask::Connector::SceneObjectRemoved( Object& object )
771 void RenderTask::Connector::ObjectDestroyed( Object& object )
778 void RenderTask::Connector::UpdateRenderTask()
780 // Guard to allow handle destruction after Core has been destroyed
781 if( Internal::Stage::IsInstalled() &&
782 mRenderTask.mSceneObject )
784 const SceneGraph::Node* node( NULL );
786 // Check whether a Node exists in the scene-graph
787 if ( NULL != mActor )
789 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
790 if ( NULL != object )
792 // actors only point to nodes as their scene objects
793 node = static_cast< const SceneGraph::Node* >( object );
797 //the mapping node is not used in the scene graph
798 if ( SOURCE_CONNECTOR == mType )
800 SetSourceNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
802 else if( CAMERA_CONNECTOR == mType )
804 SetCameraNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
809 } // namespace Internal