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( "viewportPosition", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_POSITION )
58 DALI_PROPERTY( "viewportSize", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_SIZE )
59 DALI_PROPERTY( "clearColor", 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 Internal::Stage* stage = Internal::Stage::GetCurrent();
242 Vector2 size( stage->GetSize() );
243 viewPort.x = viewPort.y = 0;
244 viewPort.width = size.width;
245 viewPort.height = size.height;
251 const Vector2& position = mSceneObject->GetViewportPosition(bufferIndex);
252 const Vector2& size = mSceneObject->GetViewportSize(bufferIndex);
253 viewPort.x = position.x;
254 viewPort.y = position.y;
255 viewPort.width = size.width;
256 viewPort.height = size.height;
260 void RenderTask::SetClearColor( const Vector4& color )
262 if ( mClearColor != color )
268 // mSceneObject is being used in a separate thread; queue a message to set the value
269 BakeClearColorMessage( GetEventThreadServices(), *mSceneObject, color );
274 const Vector4& RenderTask::GetClearColor() const
276 return mSceneObject->GetClearColor( GetEventThreadServices().GetEventBufferIndex() );
279 void RenderTask::SetClearEnabled( bool enabled )
281 if ( mClearEnabled != enabled )
283 mClearEnabled = enabled;
287 // mSceneObject is being used in a separate thread; queue a message to set the value
288 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
293 bool RenderTask::GetClearEnabled() const
295 return mClearEnabled;
298 void RenderTask::SetCullMode( bool mode )
300 if ( mCullMode != mode )
306 // mSceneObject is being used in a separate thread; queue a message to set the value
307 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
312 bool RenderTask::GetCullMode() const
317 void RenderTask::SetRefreshRate( unsigned int refreshRate )
319 DALI_LOG_TRACE_METHOD_FMT(gLogRender, "this:%p rate:%d\n", this, refreshRate);
320 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::SetRefreshRate(this:%p, %d)\n", this, refreshRate);
322 mRefreshRate = refreshRate; // cached for GetRefreshRate()
324 // Note - even when refreshRate is the same as mRefreshRate, a message should be sent
328 // mSceneObject is being used in a separate thread; queue a message to set the value
329 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, refreshRate );
333 unsigned int RenderTask::GetRefreshRate() const
338 bool RenderTask::IsHittable( Vector2& screenCoords ) const
340 // True when input is enabled, source & camera actor are valid
341 bool inputEnabled( false );
343 Actor* sourceActor = GetSourceActor();
344 CameraActor* cameraActor = GetCameraActor();
346 if ( mInputEnabled &&
347 NULL != sourceActor &&
348 sourceActor->OnStage() &&
349 NULL != cameraActor &&
350 cameraActor->OnStage() )
352 // If the actors are rendered off-screen, then the screen coordinates must be converted
353 // and the conversion function will tell us if they are inside or outside
354 if ( TranslateCoordinates( screenCoords ) )
356 // This is a suitable render-task for input handling
364 bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
366 // return true for on-screen tasks
368 // If the actors are rendered off-screen, then the screen coordinates must be converted
369 // the function should only be called for offscreen tasks
370 if( mFrameBufferImage && mMappingConnector.mActor )
372 CameraActor* localCamera = GetCameraActor();
373 StagePtr stage = Stage::GetCurrent();
376 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
380 Vector2 size( stage->GetSize() );
381 viewport.x = viewport.y = 0;
382 viewport.width = size.width;
383 viewport.height = size.height;
385 float localX, localY;
386 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
387 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
388 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
390 screenCoords.x = localX;
391 screenCoords.y = localY;
404 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
406 inside = mScreenToFrameBufferFunction( screenCoords );
411 bool RenderTask::IsSystemLevel() const
413 return mIsSystemLevel;
416 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
418 // This should only be called once, with no existing scene-object
419 DALI_ASSERT_DEBUG( NULL == mSceneObject );
421 // Keep the raw-pointer until DiscardSceneObject is called
422 mSceneObject = SceneGraph::RenderTask::New();
424 // 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
425 unsigned int resourceId = 0;
426 if(mFrameBufferImage)
428 GetImplementation(mFrameBufferImage).Connect();
430 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
433 // mSceneObject is being used in a separate thread; queue a message to set the value
434 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
436 // Send messages to set other properties that may have changed since last time we were on stage
437 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
438 SetClearColorMessage( GetEventThreadServices(), *mSceneObject, mClearColor );
439 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
440 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
441 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, mRefreshRate );
443 // Caller takes ownership
447 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
452 void RenderTask::DiscardSceneObject()
454 // mSceneObject is not owned; throw away the raw-pointer
457 // if we have a frame buffer we need to track connection status
458 if(mFrameBufferImage)
460 GetImplementation(mFrameBufferImage).Disconnect();
464 /********************************************************************************
465 ******************************** PROPERTY METHODS **************************
466 ********************************************************************************/
468 unsigned int RenderTask::GetDefaultPropertyCount() const
470 return DEFAULT_PROPERTY_COUNT;
473 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
475 indices.Reserve( DEFAULT_PROPERTY_COUNT );
477 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
479 indices.PushBack( i );
483 const char* RenderTask::GetDefaultPropertyName( Property::Index index ) const
485 if( index < DEFAULT_PROPERTY_COUNT )
487 return DEFAULT_PROPERTY_DETAILS[index].name;
495 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
497 Property::Index index = Property::INVALID_INDEX;
499 // Look for name in default properties
500 for( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
502 if( 0 == strcmp( name.c_str(), DEFAULT_PROPERTY_DETAILS[i].name ) ) // dont want to convert rhs to string
512 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
514 return DEFAULT_PROPERTY_DETAILS[ index ].writable;
517 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
519 return DEFAULT_PROPERTY_DETAILS[ index ].animatable;
522 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
524 return DEFAULT_PROPERTY_DETAILS[ index ].constraintInput;
527 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
529 if( index < DEFAULT_PROPERTY_COUNT )
531 return DEFAULT_PROPERTY_DETAILS[index].type;
534 // index out of range...return Property::NONE
535 return Property::NONE;
538 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
542 case Dali::RenderTask::Property::VIEWPORT_POSITION:
544 SetViewportPosition( property.Get<Vector2>() );
547 case Dali::RenderTask::Property::VIEWPORT_SIZE:
549 SetViewportSize( property.Get<Vector2>() );
552 case Dali::RenderTask::Property::CLEAR_COLOR:
554 SetClearColor( property.Get<Vector4>() );
565 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
567 Property::Value value;
572 case Dali::RenderTask::Property::VIEWPORT_POSITION:
574 value = GetCurrentViewportPosition();
577 case Dali::RenderTask::Property::VIEWPORT_SIZE:
579 value = GetCurrentViewportSize();
582 case Dali::RenderTask::Property::CLEAR_COLOR:
584 value = GetClearColor();
590 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
598 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
603 const SceneGraph::PropertyBase* RenderTask::GetSceneObjectAnimatableProperty( Property::Index index ) const
605 DALI_ASSERT_ALWAYS( IsPropertyAnimatable(index) && "Property is not animatable" );
607 const SceneGraph::PropertyBase* property( NULL );
609 // This method should only return a property which is part of the scene-graph
610 if( mSceneObject != NULL )
614 case Dali::RenderTask::Property::VIEWPORT_POSITION:
615 property = &mSceneObject->mViewportPosition;
618 case Dali::RenderTask::Property::VIEWPORT_SIZE:
619 property = &mSceneObject->mViewportSize;
622 case Dali::RenderTask::Property::CLEAR_COLOR:
623 property = &mSceneObject->mClearColor;
634 const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Index index ) const
636 const PropertyInputImpl* property( NULL );
637 if( mSceneObject != NULL )
641 case Dali::RenderTask::Property::VIEWPORT_POSITION:
642 property = &mSceneObject->mViewportPosition;
645 case Dali::RenderTask::Property::VIEWPORT_SIZE:
646 property = &mSceneObject->mViewportSize;
649 case Dali::RenderTask::Property::CLEAR_COLOR:
650 property = &mSceneObject->mViewportSize;
661 bool RenderTask::HasFinished()
663 bool finished = false;
664 const unsigned int counter = mSceneObject->GetRenderedOnceCounter();
666 if( mRefreshOnceCounter < counter )
669 mRefreshOnceCounter = counter;
672 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::HasFinished()=%s SCRT:%p SC\n", finished?"T":"F", mSceneObject);
677 void RenderTask::EmitSignalFinish()
679 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::EmitSignalFinish(this:%p)\n", this);
681 if( !mSignalFinished.Empty() )
683 Dali::RenderTask handle( this );
684 mSignalFinished.Emit(handle );
688 Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
690 return mSignalFinished;
693 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
695 bool connected( true );
696 RenderTask* renderTask = dynamic_cast<RenderTask*>(object);
698 if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
700 renderTask->FinishedSignal().Connect( tracker, functor );
704 // signalName does not match any signal
711 RenderTask::RenderTask( bool isSystemLevel )
712 : mSceneObject( NULL ),
713 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
714 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
715 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
716 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
717 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
718 mRefreshOnceCounter( 0u ),
719 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
720 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
721 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
722 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
723 mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
724 mIsSystemLevel( isSystemLevel )
726 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
729 RenderTask::~RenderTask()
731 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::~RenderTask(this:%p)\n", this);
734 // Helper class for connecting Nodes to the scene-graph RenderTask
736 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
738 mRenderTask( renderTask ),
743 RenderTask::Connector::~Connector()
748 void RenderTask::Connector::SetActor( Actor* actor )
750 if ( mActor != actor )
754 mActor->RemoveObserver( *this );
761 mActor->AddObserver( *this );
768 void RenderTask::Connector::SceneObjectAdded( Object& object )
773 void RenderTask::Connector::SceneObjectRemoved( Object& object )
778 void RenderTask::Connector::ObjectDestroyed( Object& object )
780 if ( SOURCE_CONNECTOR == mType )
782 const Stage* stage = Stage::GetCurrent();
785 stage->GetRenderTaskList().SetExclusive( &mRenderTask, false );
794 void RenderTask::Connector::UpdateRenderTask()
796 // Guard to allow handle destruction after Core has been destroyed
797 if( Internal::Stage::IsInstalled() &&
798 mRenderTask.mSceneObject )
800 const SceneGraph::Node* node( NULL );
802 // Check whether a Node exists in the scene-graph
803 if ( NULL != mActor )
805 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
806 if ( NULL != object )
808 // actors only point to nodes as their scene objects
809 node = static_cast< const SceneGraph::Node* >( object );
813 //the mapping node is not used in the scene graph
814 if ( SOURCE_CONNECTOR == mType )
816 SetSourceNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
818 else if( CAMERA_CONNECTOR == mType )
820 SetCameraNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
825 } // namespace Internal