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/internal/common/event-to-update.h>
24 #include <dali/internal/event/actors/actor-impl.h>
25 #include <dali/internal/event/actors/camera-actor-impl.h>
26 #include <dali/internal/event/common/stage-impl.h>
27 #include <dali/internal/event/common/thread-local-storage.h>
28 #include <dali/internal/event/images/frame-buffer-image-impl.h>
29 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
30 #include <dali/internal/update/nodes/node.h>
32 #if defined(DEBUG_ENABLED)
35 Debug::Filter* gLogRender = Debug::Filter::New(Debug::Concise, false, "LOG_RENDER_TASK");
42 const Property::Index RenderTask::VIEWPORT_POSITION = 0;
43 const Property::Index RenderTask::VIEWPORT_SIZE = 1;
44 const Property::Index RenderTask::CLEAR_COLOR = 2;
49 namespace // For internal properties
52 const std::string DEFAULT_PROPERTY_NAMES[] =
58 const int DEFAULT_PROPERTY_COUNT = sizeof( DEFAULT_PROPERTY_NAMES ) / sizeof( std::string );
60 const Property::Type DEFAULT_PROPERTY_TYPES[DEFAULT_PROPERTY_COUNT] =
62 Property::VECTOR2, // viewport-position
63 Property::VECTOR2, // viewport-size
64 Property::VECTOR4, // clear-color
69 RenderTask::DefaultPropertyLookup* RenderTask::sDefaultPropertyLookup = NULL;
71 RenderTask* RenderTask::New( bool isSystemLevel )
73 RenderTask* task( new RenderTask( ThreadLocalStorage::Get().GetEventToUpdate(), 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( mEventToUpdate, *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( mEventToUpdate, *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 StagePtr stage = Stage::GetCurrent();
190 BakeViewportPositionMessage( stage->GetUpdateInterface(), *mSceneObject, value );
193 Vector2 RenderTask::GetCurrentViewportPosition() const
195 StagePtr stage = Stage::GetCurrent();
196 return mSceneObject->GetViewportPosition(stage->GetEventBufferIndex());
199 void RenderTask::SetViewportSize(const Vector2& value)
201 StagePtr stage = Stage::GetCurrent();
202 BakeViewportSizeMessage( stage->GetUpdateInterface(), *mSceneObject, value );
205 Vector2 RenderTask::GetCurrentViewportSize() const
207 StagePtr stage = Stage::GetCurrent();
208 return mSceneObject->GetViewportSize(stage->GetEventBufferIndex());
211 void RenderTask::SetViewport( const Viewport& viewport )
213 SetViewportPosition(Vector2(viewport.x, viewport.y));
214 SetViewportSize(Vector2(viewport.width, viewport.height));
217 void RenderTask::GetViewport( Viewport& viewPort ) const
219 BufferIndex bufferIndex = Stage::GetCurrent()->GetEventBufferIndex();
221 if(!mSceneObject->GetViewportEnabled( bufferIndex ))
223 if ( mFrameBufferImage )
225 viewPort.x = viewPort.y = 0;
226 viewPort.width = mFrameBufferImage.GetWidth();
227 viewPort.height = mFrameBufferImage.GetHeight();
231 Vector2 size( Stage::GetCurrent()->GetSize() );
232 viewPort.x = viewPort.y = 0;
233 viewPort.width = size.width;
234 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 StagePtr stage = Stage::GetCurrent();
258 BakeClearColorMessage( stage->GetUpdateInterface(), *mSceneObject, color );
263 const Vector4& RenderTask::GetClearColor() const
265 StagePtr stage = Stage::GetCurrent();
266 return mSceneObject->GetClearColor(stage->GetEventBufferIndex());
269 void RenderTask::SetClearEnabled( bool enabled )
271 if ( mClearEnabled != enabled )
273 mClearEnabled = enabled;
277 // mSceneObject is being used in a separate thread; queue a message to set the value
278 SetClearEnabledMessage( mEventToUpdate, *mSceneObject, mClearEnabled );
283 bool RenderTask::GetClearEnabled() const
285 return mClearEnabled;
288 void RenderTask::SetRefreshRate( unsigned int refreshRate )
290 DALI_LOG_TRACE_METHOD_FMT(gLogRender, "this:%p rate:%d\n", this, refreshRate);
291 DALI_LOG_INFO(gLogRender, Debug::General, "RenderTask::SetRefreshRate(this:%p, %d)\n", this, refreshRate);
293 mRefreshRate = refreshRate; // cached for GetRefreshRate()
295 // Note - even when refreshRate is the same as mRefreshRate, a message should be sent
299 // mSceneObject is being used in a separate thread; queue a message to set the value
300 SetRefreshRateMessage( mEventToUpdate, *mSceneObject, refreshRate );
304 unsigned int RenderTask::GetRefreshRate() const
309 bool RenderTask::IsHittable( Vector2& screenCoords ) const
311 // True when input is enabled, source & camera actor are valid
312 bool inputEnabled( false );
314 Actor* sourceActor = GetSourceActor();
315 CameraActor* cameraActor = GetCameraActor();
317 if ( mInputEnabled &&
318 NULL != sourceActor &&
319 sourceActor->OnStage() &&
320 NULL != cameraActor &&
321 cameraActor->OnStage() )
323 // If the actors are rendered off-screen, then the screen coordinates must be converted
324 // and the conversion function will tell us if they are inside or outside
325 if ( TranslateCoordinates( screenCoords ) )
327 // This is a suitable render-task for input handling
335 bool RenderTask::TranslateCoordinates( Vector2& screenCoords ) const
337 // return true for on-screen tasks
339 // If the actors are rendered off-screen, then the screen coordinates must be converted
340 // the function should only be called for offscreen tasks
341 if( mFrameBufferImage && mMappingConnector.mActor )
343 CameraActor* localCamera = GetCameraActor();
344 StagePtr stage = Stage::GetCurrent();
345 CameraActor& defaultCamera = stage->GetDefaultCameraActor();
349 Vector2 size( stage->GetSize() );
350 viewport.x = viewport.y = 0;
351 viewport.width = size.width;
352 viewport.height = size.height;
354 float localX, localY;
355 inside = mMappingConnector.mActor->ScreenToLocal(defaultCamera.GetViewMatrix(), defaultCamera.GetProjectionMatrix(), viewport, localX, localY, screenCoords.x, screenCoords.y);
356 Vector3 actorSize = mMappingConnector.mActor->GetCurrentSize();
357 if( inside && localX >= 0.f && localX <= actorSize.x && localY >= 0.f && localY <= actorSize.y)
359 screenCoords.x = localX;
360 screenCoords.y = localY;
372 else if ( mFrameBufferImage && mScreenToFrameBufferFunction )
374 inside = mScreenToFrameBufferFunction( screenCoords );
379 bool RenderTask::IsSystemLevel() const
381 return mIsSystemLevel;
384 SceneGraph::RenderTask* RenderTask::CreateSceneObject()
386 // This should only be called once, with no existing scene-object
387 DALI_ASSERT_DEBUG( NULL == mSceneObject );
389 // Keep the raw-pointer until DiscardSceneObject is called
390 mSceneObject = SceneGraph::RenderTask::New();
392 // 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
393 unsigned int resourceId = 0;
394 if(mFrameBufferImage)
396 GetImplementation(mFrameBufferImage).Connect();
398 resourceId = GetImplementation( mFrameBufferImage ).GetResourceId();
401 // mSceneObject is being used in a separate thread; queue a message to set the value
402 SetFrameBufferIdMessage( mEventToUpdate, *mSceneObject, resourceId );
404 // Send messages to set other properties that may have changed since last time we were on stage
405 SetExclusiveMessage( mEventToUpdate, *mSceneObject, mExclusive );
406 SetClearColorMessage( mEventToUpdate, *mSceneObject, mClearColor );
407 SetClearEnabledMessage( mEventToUpdate, *mSceneObject, mClearEnabled );
408 SetRefreshRateMessage( mEventToUpdate, *mSceneObject, mRefreshRate );
410 // Caller takes ownership
414 SceneGraph::RenderTask* RenderTask::GetRenderTaskSceneObject()
419 void RenderTask::DiscardSceneObject()
421 // mSceneObject is not owned; throw away the raw-pointer
424 // if we have a frame buffer we need to track connection status
425 if(mFrameBufferImage)
427 GetImplementation(mFrameBufferImage).Disconnect();
431 /********************************************************************************
432 ********************************************************************************
433 ******************************** PROPERTY METHODS **************************
434 ********************************************************************************
435 ********************************************************************************/
437 bool RenderTask::IsSceneObjectRemovable() const
439 return false; // The scene object is permanently "on stage" whilst this object is alive
442 unsigned int RenderTask::GetDefaultPropertyCount() const
444 return DEFAULT_PROPERTY_COUNT;
447 void RenderTask::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
449 indices.reserve( DEFAULT_PROPERTY_COUNT );
451 for ( int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
453 indices.push_back( i );
457 const std::string& RenderTask::GetDefaultPropertyName( Property::Index index ) const
459 if( index < DEFAULT_PROPERTY_COUNT )
461 return DEFAULT_PROPERTY_NAMES[index];
465 // index out of range..return empty string
466 static const std::string INVALID_PROPERTY_NAME;
467 return INVALID_PROPERTY_NAME;
471 Property::Index RenderTask::GetDefaultPropertyIndex(const std::string& name) const
473 Property::Index index = Property::INVALID_INDEX;
475 // Lazy initialization of static sDefaultPropertyLookup
476 if (!sDefaultPropertyLookup)
478 sDefaultPropertyLookup = new DefaultPropertyLookup();
480 for (int i=0; i<DEFAULT_PROPERTY_COUNT; ++i)
482 (*sDefaultPropertyLookup)[DEFAULT_PROPERTY_NAMES[i]] = i;
485 DALI_ASSERT_DEBUG( NULL != sDefaultPropertyLookup );
487 // Look for name in default properties
488 DefaultPropertyLookup::const_iterator result = sDefaultPropertyLookup->find( name );
489 if ( sDefaultPropertyLookup->end() != result )
491 index = result->second;
497 bool RenderTask::IsDefaultPropertyWritable(Property::Index index) const
502 bool RenderTask::IsDefaultPropertyAnimatable(Property::Index index) const
507 bool RenderTask::IsDefaultPropertyAConstraintInput( Property::Index index ) const
512 Property::Type RenderTask::GetDefaultPropertyType(Property::Index index) const
514 if( index < DEFAULT_PROPERTY_COUNT )
516 return DEFAULT_PROPERTY_TYPES[index];
520 // index out of range...return Property::NONE
521 return Property::NONE;
525 void RenderTask::SetDefaultProperty( Property::Index index, const Property::Value& property )
529 case Dali::RenderTask::VIEWPORT_POSITION:
531 SetViewportPosition( property.Get<Vector2>() );
534 case Dali::RenderTask::VIEWPORT_SIZE:
536 SetViewportSize( property.Get<Vector2>() );
539 case Dali::RenderTask::CLEAR_COLOR:
541 SetClearColor( property.Get<Vector4>() );
547 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
553 void RenderTask::SetCustomProperty( Property::Index /*index*/, const CustomProperty& /*entry*/, const Property::Value& /*value*/ )
555 // TODO: support them, it doesn't hurt.
556 DALI_ASSERT_ALWAYS( 0 && "RenderTask does not support custom properties");
559 Property::Value RenderTask::GetDefaultProperty(Property::Index index) const
561 Property::Value value;
566 case Dali::RenderTask::VIEWPORT_POSITION:
568 value = GetCurrentViewportPosition();
571 case Dali::RenderTask::VIEWPORT_SIZE:
573 value = GetCurrentViewportSize();
576 case Dali::RenderTask::CLEAR_COLOR:
578 value = GetClearColor();
584 DALI_ASSERT_ALWAYS(false && "RenderTask property index out of range"); // should not come here
592 void RenderTask::InstallSceneObjectProperty( SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index )
594 // TODO: support them, it doesn't hurt.
595 DALI_ASSERT_ALWAYS( 0 && "RenderTask does not support custom properties" );
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::VIEWPORT_POSITION:
615 property = &mSceneObject->mViewportPosition;
618 case Dali::RenderTask::VIEWPORT_SIZE:
619 property = &mSceneObject->mViewportSize;
622 case Dali::RenderTask::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::VIEWPORT_POSITION:
642 property = &mSceneObject->mViewportPosition;
645 case Dali::RenderTask::VIEWPORT_SIZE:
646 property = &mSceneObject->mViewportSize;
649 case Dali::RenderTask::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( !mSignalFinishedV2.Empty() )
683 Dali::RenderTask handle( this );
684 mSignalFinishedV2.Emit(handle );
688 Dali::RenderTask::RenderTaskSignalV2& RenderTask::FinishedSignal()
690 return mSignalFinishedV2;
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 ( Dali::RenderTask::SIGNAL_FINISHED == signalName )
700 renderTask->FinishedSignal().Connect( tracker, functor );
704 // signalName does not match any signal
711 RenderTask::RenderTask( EventToUpdate& eventToUpdate, bool isSystemLevel )
712 : mEventToUpdate( eventToUpdate ),
713 mSceneObject( NULL ),
714 mSourceConnector( Connector::SOURCE_CONNECTOR, *this ),
715 mCameraConnector( Connector::CAMERA_CONNECTOR, *this ),
716 mMappingConnector( Connector::MAPPING_CONNECTOR, *this ),
717 mClearColor( Dali::RenderTask::DEFAULT_CLEAR_COLOR ),
718 mRefreshRate( Dali::RenderTask::DEFAULT_REFRESH_RATE ),
719 mRefreshOnceCounter( 0u ),
720 mScreenToFrameBufferFunction( Dali::RenderTask::DEFAULT_SCREEN_TO_FRAMEBUFFER_FUNCTION ),
721 mExclusive( Dali::RenderTask::DEFAULT_EXCLUSIVE ),
722 mInputEnabled( Dali::RenderTask::DEFAULT_INPUT_ENABLED ),
723 mClearEnabled( Dali::RenderTask::DEFAULT_CLEAR_ENABLED ),
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( ProxyObject& proxy )
773 void RenderTask::Connector::SceneObjectRemoved( ProxyObject& proxy )
778 void RenderTask::Connector::ProxyDestroyed( ProxyObject& proxy )
785 void RenderTask::Connector::UpdateRenderTask()
787 // Guard to allow handle destruction after Core has been destroyed
788 if( Internal::Stage::IsInstalled() &&
789 mRenderTask.mSceneObject )
791 const SceneGraph::Node* node( NULL );
793 // Check whether a Node exists in the scene-graph
794 if ( NULL != mActor )
796 const SceneGraph::PropertyOwner* object = mActor->GetSceneObject();
797 if ( NULL != object )
799 // actors only point to nodes as their scene objects
800 node = static_cast< const SceneGraph::Node* >( object );
804 //the mapping node is not used in the scene graph
805 if ( SOURCE_CONNECTOR == mType )
807 SetSourceNodeMessage( mRenderTask.mEventToUpdate, *(mRenderTask.mSceneObject), node );
809 else if( CAMERA_CONNECTOR == mType )
811 SetCameraNodeMessage( mRenderTask.mEventToUpdate, *(mRenderTask.mSceneObject), node );
816 } // namespace Internal