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/update/render-tasks/scene-graph-render-task.h>
36 #if defined(DEBUG_ENABLED)
39 Debug::Filter* gLogRender = Debug::Filter::New(Debug::Concise, false, "LOG_RENDER_TASK");
49 namespace // For internal properties
54 // Name Type writable animatable constraint-input enum for index-checking
55 DALI_PROPERTY_TABLE_BEGIN
56 DALI_PROPERTY( "viewport-position", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_POSITION )
57 DALI_PROPERTY( "viewport-size", VECTOR2, true, true, true, Dali::RenderTask::Property::VIEWPORT_SIZE )
58 DALI_PROPERTY( "clear-color", VECTOR4, true, true, true, Dali::RenderTask::Property::CLEAR_COLOR )
59 DALI_PROPERTY_TABLE_END( DEFAULT_OBJECT_PROPERTY_START_INDEX )
63 const char* const SIGNAL_FINISHED = "finished";
65 TypeRegistration mType( typeid( Dali::RenderTask ), typeid( Dali::BaseHandle ), NULL );
67 SignalConnectorType signalConnector1( mType, SIGNAL_FINISHED, &RenderTask::DoConnectSignal );
69 } // Unnamed namespace
71 RenderTask* RenderTask::New( bool isSystemLevel )
73 RenderTask* task( new RenderTask( isSystemLevel ) );
78 void RenderTask::SetSourceActor( Actor* actor )
80 mSourceConnector.SetActor( actor );
83 Actor* RenderTask::GetSourceActor() const
85 return mSourceConnector.mActor;
88 void RenderTask::SetExclusive( bool exclusive )
90 if ( mExclusive != exclusive )
92 mExclusive = exclusive;
96 // mSceneObject is being used in a separate thread; queue a message to set the value
97 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
102 bool RenderTask::IsExclusive() const
107 void RenderTask::SetInputEnabled( bool enabled )
109 mInputEnabled = enabled;
112 bool RenderTask::GetInputEnabled() const
114 return mInputEnabled;
117 void RenderTask::SetCameraActor( CameraActor* cameraActor )
119 mCameraConnector.SetActor( cameraActor );
122 CameraActor* RenderTask::GetCameraActor() const
124 // camera connector can only point to camera actor
125 return static_cast< CameraActor* >( mCameraConnector.mActor );
128 void RenderTask::SetTargetFrameBuffer( Dali::FrameBufferImage image )
130 if ( mFrameBufferImage != image )
132 // if we have a scene object we need to track connection status and set frame buffer id as well as updating target frame buffer
135 if(mFrameBufferImage)
137 GetImplementation(mFrameBufferImage).Disconnect();
140 // update target frame buffer
141 mFrameBufferImage = image;
143 unsigned int resourceId = 0;
144 if(mFrameBufferImage)
146 GetImplementation(mFrameBufferImage).Connect();
148 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
151 // mSceneObject is being used in a separate thread; queue a message to set the value
152 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
156 // update target frame buffer
157 mFrameBufferImage = image;
162 Dali::FrameBufferImage RenderTask::GetTargetFrameBuffer() const
164 return mFrameBufferImage;
167 void RenderTask::SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction )
169 mScreenToFrameBufferFunction = conversionFunction;
172 RenderTask::ScreenToFrameBufferFunction RenderTask::GetScreenToFrameBufferFunction() const
174 return mScreenToFrameBufferFunction;
177 void RenderTask::SetScreenToFrameBufferMappingActor( Actor* mappingActor )
179 mMappingConnector.SetActor( mappingActor );
182 Actor* RenderTask::GetScreenToFrameBufferMappingActor() const
184 return mMappingConnector.mActor;
187 void RenderTask::SetViewportPosition(const Vector2& value)
189 BakeViewportPositionMessage( GetEventThreadServices(), *mSceneObject, value );
192 Vector2 RenderTask::GetCurrentViewportPosition() const
194 return mSceneObject->GetViewportPosition( GetEventThreadServices().GetEventBufferIndex() );
197 void RenderTask::SetViewportSize(const Vector2& value)
199 BakeViewportSizeMessage( GetEventThreadServices(), *mSceneObject, value );
202 Vector2 RenderTask::GetCurrentViewportSize() const
204 return mSceneObject->GetViewportSize( GetEventThreadServices().GetEventBufferIndex() );
207 void RenderTask::SetViewport( const Viewport& viewport )
209 SetViewportPosition(Vector2(viewport.x, viewport.y));
210 SetViewportSize(Vector2(viewport.width, viewport.height));
213 void RenderTask::GetViewport( Viewport& viewPort ) const
215 BufferIndex bufferIndex = GetEventThreadServices().GetEventBufferIndex();
217 if(!mSceneObject->GetViewportEnabled( bufferIndex ))
219 if ( mFrameBufferImage )
221 viewPort.x = viewPort.y = 0;
222 viewPort.width = mFrameBufferImage.GetWidth();
223 viewPort.height = mFrameBufferImage.GetHeight();
227 Internal::Stage* stage = Internal::Stage::GetCurrent();
230 Vector2 size( stage->GetSize() );
231 viewPort.x = viewPort.y = 0;
232 viewPort.width = size.width;
233 viewPort.height = size.height;
239 const Vector2& position = mSceneObject->GetViewportPosition(bufferIndex);
240 const Vector2& size = mSceneObject->GetViewportSize(bufferIndex);
241 viewPort.x = position.x;
242 viewPort.y = position.y;
243 viewPort.width = size.width;
244 viewPort.height = size.height;
248 void RenderTask::SetClearColor( const Vector4& color )
250 if ( mClearColor != color )
256 // mSceneObject is being used in a separate thread; queue a message to set the value
257 BakeClearColorMessage( GetEventThreadServices(), *mSceneObject, color );
262 const Vector4& RenderTask::GetClearColor() const
264 return mSceneObject->GetClearColor( GetEventThreadServices().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( GetEventThreadServices(), *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( GetEventThreadServices(), *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( GetEventThreadServices(), *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();
364 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
368 Vector2 size( stage->GetSize() );
369 viewport.x = viewport.y = 0;
370 viewport.width = size.width;
371 viewport.height = size.height;
373 float localX, localY;
374 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
375 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
376 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
378 screenCoords.x = localX;
379 screenCoords.y = localY;
392 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
394 inside = mScreenToFrameBufferFunction( screenCoords );
399 bool RenderTask::IsSystemLevel() const
401 return mIsSystemLevel;
404 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
406 // This should only be called once, with no existing scene-object
407 DALI_ASSERT_DEBUG( NULL == mSceneObject );
409 // Keep the raw-pointer until DiscardSceneObject is called
410 mSceneObject = SceneGraph::RenderTask::New();
412 // 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
413 unsigned int resourceId = 0;
414 if(mFrameBufferImage)
416 GetImplementation(mFrameBufferImage).Connect();
418 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
421 // mSceneObject is being used in a separate thread; queue a message to set the value
422 SetFrameBufferIdMessage( GetEventThreadServices(), *mSceneObject, resourceId );
424 // Send messages to set other properties that may have changed since last time we were on stage
425 SetExclusiveMessage( GetEventThreadServices(), *mSceneObject, mExclusive );
426 SetClearColorMessage( GetEventThreadServices(), *mSceneObject, mClearColor );
427 SetClearEnabledMessage( GetEventThreadServices(), *mSceneObject, mClearEnabled );
428 SetCullModeMessage( GetEventThreadServices(), *mSceneObject, mCullMode );
429 SetRefreshRateMessage( GetEventThreadServices(), *mSceneObject, mRefreshRate );
431 // Caller takes ownership
435 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
440 void RenderTask::DiscardSceneObject()
442 // mSceneObject is not owned; throw away the raw-pointer
445 // if we have a frame buffer we need to track connection status
446 if(mFrameBufferImage)
448 GetImplementation(mFrameBufferImage).Disconnect();
452 /********************************************************************************
453 ******************************** PROPERTY METHODS **************************
454 ********************************************************************************/
456 unsigned int RenderTask::GetDefaultPropertyCount() const
458 return DEFAULT_PROPERTY_COUNT;
461 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
463 indices.Reserve( DEFAULT_PROPERTY_COUNT );
465 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
467 indices.PushBack( i );
471 const char* RenderTask::GetDefaultPropertyName( Property::Index index ) const
473 if( index < DEFAULT_PROPERTY_COUNT )
475 return DEFAULT_PROPERTY_DETAILS[index].name;
483 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
485 Property::Index index = Property::INVALID_INDEX;
487 // Look for name in default properties
488 for( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
490 if( 0 == strcmp( name.c_str(), DEFAULT_PROPERTY_DETAILS[i].name ) ) // dont want to convert rhs to string
500 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
502 return DEFAULT_PROPERTY_DETAILS[ index ].writable;
505 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
507 return DEFAULT_PROPERTY_DETAILS[ index ].animatable;
510 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
512 return DEFAULT_PROPERTY_DETAILS[ index ].constraintInput;
515 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
517 if( index < DEFAULT_PROPERTY_COUNT )
519 return DEFAULT_PROPERTY_DETAILS[index].type;
522 // index out of range...return Property::NONE
523 return Property::NONE;
526 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
530 case Dali::RenderTask::Property::VIEWPORT_POSITION:
532 SetViewportPosition( property.Get<Vector2>() );
535 case Dali::RenderTask::Property::VIEWPORT_SIZE:
537 SetViewportSize( property.Get<Vector2>() );
540 case Dali::RenderTask::Property::CLEAR_COLOR:
542 SetClearColor( property.Get<Vector4>() );
553 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
555 Property::Value value;
560 case Dali::RenderTask::Property::VIEWPORT_POSITION:
562 value = GetCurrentViewportPosition();
565 case Dali::RenderTask::Property::VIEWPORT_SIZE:
567 value = GetCurrentViewportSize();
570 case Dali::RenderTask::Property::CLEAR_COLOR:
572 value = GetClearColor();
578 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
586 const SceneGraph::PropertyOwner* RenderTask::GetSceneObject() const
591 const SceneGraph::PropertyBase* RenderTask::GetSceneObjectAnimatableProperty( Property::Index index ) const
593 DALI_ASSERT_ALWAYS( IsPropertyAnimatable(index) && "Property is not animatable" );
595 const SceneGraph::PropertyBase* property( NULL );
597 // This method should only return a property which is part of the scene-graph
598 if( mSceneObject != NULL )
602 case Dali::RenderTask::Property::VIEWPORT_POSITION:
603 property = &mSceneObject->mViewportPosition;
606 case Dali::RenderTask::Property::VIEWPORT_SIZE:
607 property = &mSceneObject->mViewportSize;
610 case Dali::RenderTask::Property::CLEAR_COLOR:
611 property = &mSceneObject->mClearColor;
622 const PropertyInputImpl* RenderTask::GetSceneObjectInputProperty( Property::Index index ) const
624 const PropertyInputImpl* property( NULL );
625 if( mSceneObject != NULL )
629 case Dali::RenderTask::Property::VIEWPORT_POSITION:
630 property = &mSceneObject->mViewportPosition;
633 case Dali::RenderTask::Property::VIEWPORT_SIZE:
634 property = &mSceneObject->mViewportSize;
637 case Dali::RenderTask::Property::CLEAR_COLOR:
638 property = &mSceneObject->mViewportSize;
649 bool RenderTask::HasFinished()
651 bool finished = false;
652 const unsigned int counter = mSceneObject->GetRenderedOnceCounter();
654 if( mRefreshOnceCounter < counter )
657 mRefreshOnceCounter = counter;
660 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::HasFinished()=%s SCRT:%p SC\n", finished?"T":"F", mSceneObject);
665 void RenderTask::EmitSignalFinish()
667 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::EmitSignalFinish(this:%p)\n", this);
669 if( !mSignalFinished.Empty() )
671 Dali::RenderTask handle( this );
672 mSignalFinished.Emit(handle );
676 Dali::RenderTask::RenderTaskSignalType& RenderTask::FinishedSignal()
678 return mSignalFinished;
681 bool RenderTask::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
683 bool connected( true );
684 RenderTask* renderTask = dynamic_cast<RenderTask*>(object);
686 if ( 0 == strcmp( signalName.c_str(), SIGNAL_FINISHED ) )
688 renderTask->FinishedSignal().Connect( tracker, functor );
692 // signalName does not match any signal
699 RenderTask::RenderTask( bool isSystemLevel )
700 : mSceneObject( NULL ),
701 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
702 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
703 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
704 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
705 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
706 mRefreshOnceCounter( 0u ),
707 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
708 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
709 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
710 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
711 mCullMode( Dali::RenderTask::DEFAULT_CULL_MODE ),
712 mIsSystemLevel( isSystemLevel )
714 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::RenderTask(this:%p)\n", this);
717 RenderTask::~RenderTask()
719 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::~RenderTask(this:%p)\n", this);
722 // Helper class for connecting Nodes to the scene-graph RenderTask
724 RenderTask::Connector::Connector( Type type, RenderTask& renderTask )
726 mRenderTask( renderTask ),
731 RenderTask::Connector::~Connector()
736 void RenderTask::Connector::SetActor( Actor* actor )
738 if ( mActor != actor )
742 mActor->RemoveObserver( *this );
749 mActor->AddObserver( *this );
756 void RenderTask::Connector::SceneObjectAdded( Object& object )
761 void RenderTask::Connector::SceneObjectRemoved( Object& object )
766 void RenderTask::Connector::ObjectDestroyed( Object& object )
773 void RenderTask::Connector::UpdateRenderTask()
775 // Guard to allow handle destruction after Core has been destroyed
776 if( Internal::Stage::IsInstalled() &&
777 mRenderTask.mSceneObject )
779 const SceneGraph::Node* node( NULL );
781 // Check whether a Node exists in the scene-graph
782 if ( NULL != mActor )
784 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
785 if ( NULL != object )
787 // actors only point to nodes as their scene objects
788 node = static_cast< const SceneGraph::Node* >( object );
792 //the mapping node is not used in the scene graph
793 if ( SOURCE_CONNECTOR == mType )
795 SetSourceNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
797 else if( CAMERA_CONNECTOR == mType )
799 SetCameraNodeMessage( mRenderTask.GetEventThreadServices(), *(mRenderTask.mSceneObject), node );
804 } // namespace Internal