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/common/event-to-update.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/common/thread-local-storage.h>
30 #include <dali/internal/event/images/frame-buffer-image-impl.h>
31 #include <dali/internal/update/nodes/node.h>
32 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
34 #if defined(DEBUG_ENABLED)
37 Debug::Filter* gLogRender = Debug::Filter::New(Debug::Concise, false, "LOG_RENDER_TASK");
47 namespace // For internal properties
52 // Name Type writable animatable constraint-input enum for index-checking
53 DALI_PROPERTY_TABLE_BEGIN
54 DALI_PROPERTY( "viewport-position", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_POSITION )
55 DALI_PROPERTY( "viewport-size", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_SIZE )
56 DALI_PROPERTY( "clear-color", VECTOR4, true, true, true, Dali::RenderTask::Property::CLEAR_COLOR )
57 DALI_PROPERTY_TABLE_END( DEFAULT_DERIVED_HANDLE_PROPERTY_START_INDEX )
61 const char* const SIGNAL_FINISHED = "finished";
63 TypeRegistration mType( typeid( Dali::RenderTask ), typeid( Dali::BaseHandle ), NULL );
65 SignalConnectorType signalConnector1( mType, SIGNAL_FINISHED, &RenderTask::DoConnectSignal );
67 } // Unnamed namespace
69 RenderTask* RenderTask::New( bool isSystemLevel )
71 RenderTask* task( new RenderTask( ThreadLocalStorage::Get().GetEventToUpdate(), isSystemLevel ) );
76 void RenderTask::SetSourceActor( Actor* actor )
78 mSourceConnector.SetActor( actor );
81 Actor* RenderTask::GetSourceActor() const
83 return mSourceConnector.mActor;
86 void RenderTask::SetExclusive( bool exclusive )
88 if ( mExclusive != exclusive )
90 mExclusive = exclusive;
94 // mSceneObject is being used in a separate thread; queue a message to set the value
95 SetExclusiveMessage( mEventToUpdate, *mSceneObject, mExclusive );
100 bool RenderTask::IsExclusive() const
105 void RenderTask::SetInputEnabled( bool enabled )
107 mInputEnabled = enabled;
110 bool RenderTask::GetInputEnabled() const
112 return mInputEnabled;
115 void RenderTask::SetCameraActor( CameraActor* cameraActor )
117 mCameraConnector.SetActor( cameraActor );
120 CameraActor* RenderTask::GetCameraActor() const
122 // camera connector can only point to camera actor
123 return static_cast< CameraActor* >( mCameraConnector.mActor );
126 void RenderTask::SetTargetFrameBuffer( Dali::FrameBufferImage image )
128 if ( mFrameBufferImage != image )
130 // if we have a scene object we need to track connection status and set frame buffer id as well as updating target frame buffer
133 if(mFrameBufferImage)
135 GetImplementation(mFrameBufferImage).Disconnect();
138 // update target frame buffer
139 mFrameBufferImage = image;
141 unsigned int resourceId = 0;
142 if(mFrameBufferImage)
144 GetImplementation(mFrameBufferImage).Connect();
146 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
149 // mSceneObject is being used in a separate thread; queue a message to set the value
150 SetFrameBufferIdMessage( mEventToUpdate, *mSceneObject, resourceId );
154 // update target frame buffer
155 mFrameBufferImage = image;
160 Dali::FrameBufferImage RenderTask::GetTargetFrameBuffer() const
162 return mFrameBufferImage;
165 void RenderTask::SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction )
167 mScreenToFrameBufferFunction = conversionFunction;
170 RenderTask::ScreenToFrameBufferFunction RenderTask::GetScreenToFrameBufferFunction() const
172 return mScreenToFrameBufferFunction;
175 void RenderTask::SetScreenToFrameBufferMappingActor( Actor* mappingActor )
177 mMappingConnector.SetActor( mappingActor );
180 Actor* RenderTask::GetScreenToFrameBufferMappingActor() const
182 return mMappingConnector.mActor;
185 void RenderTask::SetViewportPosition(const Vector2& value)
187 StagePtr stage = Stage::GetCurrent();
188 BakeViewportPositionMessage( stage->GetUpdateInterface(), *mSceneObject, value );
191 Vector2 RenderTask::GetCurrentViewportPosition() const
193 StagePtr stage = Stage::GetCurrent();
194 return mSceneObject->GetViewportPosition(stage->GetEventBufferIndex());
197 void RenderTask::SetViewportSize(const Vector2& value)
199 StagePtr stage = Stage::GetCurrent();
200 BakeViewportSizeMessage( stage->GetUpdateInterface(), *mSceneObject, value );
203 Vector2 RenderTask::GetCurrentViewportSize() const
205 StagePtr stage = Stage::GetCurrent();
206 return mSceneObject->GetViewportSize(stage->GetEventBufferIndex());
209 void RenderTask::SetViewport( const Viewport& viewport )
211 SetViewportPosition(Vector2(viewport.x, viewport.y));
212 SetViewportSize(Vector2(viewport.width, viewport.height));
215 void RenderTask::GetViewport( Viewport& viewPort ) const
217 BufferIndex bufferIndex = Stage::GetCurrent()->GetEventBufferIndex();
219 if(!mSceneObject->GetViewportEnabled( bufferIndex ))
221 if ( mFrameBufferImage )
223 viewPort.x = viewPort.y = 0;
224 viewPort.width = mFrameBufferImage.GetWidth();
225 viewPort.height = mFrameBufferImage.GetHeight();
229 Vector2 size( Stage::GetCurrent()->GetSize() );
230 viewPort.x = viewPort.y = 0;
231 viewPort.width = size.width;
232 viewPort.height = size.height;
237 const Vector2& position = mSceneObject->GetViewportPosition(bufferIndex);
238 const Vector2& size = mSceneObject->GetViewportSize(bufferIndex);
239 viewPort.x = position.x;
240 viewPort.y = position.y;
241 viewPort.width = size.width;
242 viewPort.height = size.height;
246 void RenderTask::SetClearColor( const Vector4& color )
248 if ( mClearColor != color )
254 // mSceneObject is being used in a separate thread; queue a message to set the value
255 StagePtr stage = Stage::GetCurrent();
256 BakeClearColorMessage( stage->GetUpdateInterface(), *mSceneObject, color );
261 const Vector4& RenderTask::GetClearColor() const
263 StagePtr stage = Stage::GetCurrent();
264 return mSceneObject->GetClearColor(stage->GetEventBufferIndex());
267 void RenderTask::SetClearEnabled( bool enabled )
269 if ( mClearEnabled != enabled )
271 mClearEnabled = enabled;
275 // mSceneObject is being used in a separate thread; queue a message to set the value
276 SetClearEnabledMessage( mEventToUpdate, *mSceneObject, mClearEnabled );
281 bool RenderTask::GetClearEnabled() const
283 return mClearEnabled;
286 void RenderTask::SetCullMode( bool mode )
288 if ( mCullMode != mode )
294 // mSceneObject is being used in a separate thread; queue a message to set the value
295 SetCullModeMessage( mEventToUpdate, *mSceneObject, mCullMode );
300 bool RenderTask::GetCullMode() const
305 void RenderTask::SetRefreshRate( unsigned int refreshRate )
307 DALI_LOG_TRACE_METHOD_FMT(gLogRender, "this:%p rate:%d\n", this, refreshRate);
308 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::SetRefreshRate(this:%p, %d)\n", this, refreshRate);
310 mRefreshRate = refreshRate; // cached for GetRefreshRate()
312 // Note - even when refreshRate is the same as mRefreshRate, a message should be sent
316 // mSceneObject is being used in a separate thread; queue a message to set the value
317 SetRefreshRateMessage( mEventToUpdate, *mSceneObject, refreshRate );
321 unsigned int RenderTask::GetRefreshRate() const
326 bool RenderTask::IsHittable( Vector2& screenCoords ) const
328 // True when input is enabled, source & camera actor are valid
329 bool inputEnabled( false );
331 Actor* sourceActor = GetSourceActor();
332 CameraActor* cameraActor = GetCameraActor();
334 if ( mInputEnabled &&
335 NULL != sourceActor &&
336 sourceActor->OnStage() &&
337 NULL != cameraActor &&
338 cameraActor->OnStage() )
340 // If the actors are rendered off-screen, then the screen coordinates must be converted
341 // and the conversion function will tell us if they are inside or outside
342 if ( TranslateCoordinates( screenCoords ) )
344 // This is a suitable render-task for input handling
352 bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
354 // return true for on-screen tasks
356 // If the actors are rendered off-screen, then the screen coordinates must be converted
357 // the function should only be called for offscreen tasks
358 if( mFrameBufferImage && mMappingConnector.mActor )
360 CameraActor* localCamera = GetCameraActor();
361 StagePtr stage = Stage::GetCurrent();
362 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
366 Vector2 size( stage->GetSize() );
367 viewport.x = viewport.y = 0;
368 viewport.width = size.width;
369 viewport.height = size.height;
371 float localX, localY;
372 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
373 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
374 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
376 screenCoords.x = localX;
377 screenCoords.y = localY;
389 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
391 inside = mScreenToFrameBufferFunction( screenCoords );
396 bool RenderTask::IsSystemLevel() const
398 return mIsSystemLevel;
401 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
403 // This should only be called once, with no existing scene-object
404 DALI_ASSERT_DEBUG( NULL == mSceneObject );
406 // Keep the raw-pointer until DiscardSceneObject is called
407 mSceneObject = SceneGraph::RenderTask::New();
409 // 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
410 unsigned int resourceId = 0;
411 if(mFrameBufferImage)
413 GetImplementation(mFrameBufferImage).Connect();
415 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
418 // mSceneObject is being used in a separate thread; queue a message to set the value
419 SetFrameBufferIdMessage( mEventToUpdate, *mSceneObject, resourceId );
421 // Send messages to set other properties that may have changed since last time we were on stage
422 SetExclusiveMessage( mEventToUpdate, *mSceneObject, mExclusive );
423 SetClearColorMessage( mEventToUpdate, *mSceneObject, mClearColor );
424 SetClearEnabledMessage( mEventToUpdate, *mSceneObject, mClearEnabled );
425 SetCullModeMessage( mEventToUpdate, *mSceneObject, mCullMode );
426 SetRefreshRateMessage( mEventToUpdate, *mSceneObject, mRefreshRate );
428 // Caller takes ownership
432 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
437 void RenderTask::DiscardSceneObject()
439 // mSceneObject is not owned; throw away the raw-pointer
442 // if we have a frame buffer we need to track connection status
443 if(mFrameBufferImage)
445 GetImplementation(mFrameBufferImage).Disconnect();
449 /********************************************************************************
450 ******************************** PROPERTY METHODS **************************
451 ********************************************************************************/
453 unsigned int RenderTask::GetDefaultPropertyCount() const
455 return DEFAULT_PROPERTY_COUNT;
458 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
460 indices.reserve( DEFAULT_PROPERTY_COUNT );
462 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
464 indices.push_back( i );
468 const char* RenderTask::GetDefaultPropertyName( Property::Index index ) const
470 if( index < DEFAULT_PROPERTY_COUNT )
472 return DEFAULT_PROPERTY_DETAILS[index].name;
480 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
482 Property::Index index = Property::INVALID_INDEX;
484 // Look for name in default properties
485 for( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
487 if( 0 == strcmp( name.c_str(), DEFAULT_PROPERTY_DETAILS[i].name ) ) // dont want to convert rhs to string
497 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
499 return DEFAULT_PROPERTY_DETAILS[ index ].writable;
502 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
504 return DEFAULT_PROPERTY_DETAILS[ index ].animatable;
507 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
509 return DEFAULT_PROPERTY_DETAILS[ index ].constraintInput;
512 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
514 if( index < DEFAULT_PROPERTY_COUNT )
516 return DEFAULT_PROPERTY_DETAILS[index].type;
519 // index out of range...return Property::NONE
520 return Property::NONE;
523 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
527 case Dali::RenderTask::Property::VIEWPORT_POSITION:
529 SetViewportPosition( property.Get<Vector2>() );
532 case Dali::RenderTask::Property::VIEWPORT_SIZE:
534 SetViewportSize( property.Get<Vector2>() );
537 case Dali::RenderTask::Property::CLEAR_COLOR:
539 SetClearColor( property.Get<Vector4>() );
550 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
552 Property::Value value;
557 case Dali::RenderTask::Property::VIEWPORT_POSITION:
559 value = GetCurrentViewportPosition();
562 case Dali::RenderTask::Property::VIEWPORT_SIZE:
564 value = GetCurrentViewportSize();
567 case Dali::RenderTask::Property::CLEAR_COLOR:
569 value = GetClearColor();
575 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
583 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
588 const SceneGraph::PropertyBase* RenderTask::GetSceneObjectAnimatableProperty( Property::Index index ) const
590 DALI_ASSERT_ALWAYS( IsPropertyAnimatable(index) && "Property is not animatable" );
592 const SceneGraph::PropertyBase* property( NULL );
594 // This method should only return a property which is part of the scene-graph
595 if( mSceneObject != NULL )
599 case Dali::RenderTask::Property::VIEWPORT_POSITION:
600 property = &mSceneObject->mViewportPosition;
603 case Dali::RenderTask::Property::VIEWPORT_SIZE:
604 property = &mSceneObject->mViewportSize;
607 case Dali::RenderTask::Property::CLEAR_COLOR:
608 property = &mSceneObject->mClearColor;
619 const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Index index ) const
621 const PropertyInputImpl* property( NULL );
622 if( mSceneObject != NULL )
626 case Dali::RenderTask::Property::VIEWPORT_POSITION:
627 property = &mSceneObject->mViewportPosition;
630 case Dali::RenderTask::Property::VIEWPORT_SIZE:
631 property = &mSceneObject->mViewportSize;
634 case Dali::RenderTask::Property::CLEAR_COLOR:
635 property = &mSceneObject->mViewportSize;
646 bool RenderTask::HasFinished()
648 bool finished = false;
649 const unsigned int counter = mSceneObject->GetRenderedOnceCounter();
651 if( mRefreshOnceCounter < counter )
654 mRefreshOnceCounter = counter;
657 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::HasFinished()=%s SCRT:%p SC\n", finished?"T":"F", mSceneObject);
662 void RenderTask::EmitSignalFinish()
664 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::EmitSignalFinish(this:%p)\n", this);
666 if( !mSignalFinished.Empty() )
668 Dali::RenderTask handle( this );
669 mSignalFinished.Emit(handle );
673 Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
675 return mSignalFinished;
678 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
680 bool connected( true );
681 RenderTask* renderTask = dynamic_cast<RenderTask*>(object);
683 if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
685 renderTask->FinishedSignal().Connect( tracker, functor );
689 // signalName does not match any signal
696 RenderTask::RenderTask( EventToUpdate& eventToUpdate, bool isSystemLevel )
697 : mEventToUpdate( eventToUpdate ),
698 mSceneObject( NULL ),
699 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
700 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
701 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
702 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
703 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
704 mRefreshOnceCounter( 0u ),
705 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
706 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
707 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
708 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
709 mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
710 mIsSystemLevel( isSystemLevel )
712 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
715 RenderTask::~RenderTask()
717 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::~RenderTask(this:%p)\n", this);
720 // Helper class for connecting Nodes to the scene-graph RenderTask
722 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
724 mRenderTask( renderTask ),
729 RenderTask::Connector::~Connector()
734 void RenderTask::Connector::SetActor( Actor* actor )
736 if ( mActor != actor )
740 mActor->RemoveObserver( *this );
747 mActor->AddObserver( *this );
754 void RenderTask::Connector::SceneObjectAdded( Object& object )
759 void RenderTask::Connector::SceneObjectRemoved( Object& object )
764 void RenderTask::Connector::ObjectDestroyed( Object& object )
771 void RenderTask::Connector::UpdateRenderTask()
773 // Guard to allow handle destruction after Core has been destroyed
774 if( Internal::Stage::IsInstalled() &&
775 mRenderTask.mSceneObject )
777 const SceneGraph::Node* node( NULL );
779 // Check whether a Node exists in the scene-graph
780 if ( NULL != mActor )
782 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
783 if ( NULL != object )
785 // actors only point to nodes as their scene objects
786 node = static_cast< const SceneGraph::Node* >( object );
790 //the mapping node is not used in the scene graph
791 if ( SOURCE_CONNECTOR == mType )
793 SetSourceNodeMessage( mRenderTask.mEventToUpdate, *(mRenderTask.mSceneObject), node );
795 else if( CAMERA_CONNECTOR == mType )
797 SetCameraNodeMessage( mRenderTask.mEventToUpdate, *(mRenderTask.mSceneObject), node );
802 } // namespace Internal