2 * Copyright (c) 2018 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/common/stage-impl.h>
24 #include <cstring> // for strcmp
27 #include <dali/integration-api/system-overlay.h>
28 #include <dali/internal/event/actors/layer-impl.h>
29 #include <dali/internal/event/actors/layer-list.h>
30 #include <dali/internal/event/actors/camera-actor-impl.h>
31 #include <dali/internal/event/common/system-overlay-impl.h>
32 #include <dali/internal/event/common/thread-local-storage.h>
33 #include <dali/internal/event/common/property-notification-manager.h>
34 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
35 #include <dali/internal/event/update/frame-callback-interface-impl.h>
36 #include <dali/internal/update/nodes/node.h>
37 #include <dali/internal/update/manager/scene-graph-frame-callback.h>
38 #include <dali/internal/event/common/object-registry-impl.h>
39 #include <dali/integration-api/platform-abstraction.h>
40 #include <dali/public-api/common/constants.h>
41 #include <dali/public-api/events/touch-data.h>
42 #include <dali/public-api/object/type-registry.h>
43 #include <dali/public-api/render-tasks/render-task-list.h>
44 #include <dali/public-api/rendering/frame-buffer.h>
46 using Dali::Internal::SceneGraph::Node;
50 #if defined(DEBUG_ENABLED)
51 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_DEPTH_TIMER" );
66 const char* const SIGNAL_KEY_EVENT = "keyEvent";
67 const char* const SIGNAL_KEY_EVENT_GENERATED = "keyEventGenerated";
68 const char* const SIGNAL_EVENT_PROCESSING_FINISHED = "eventProcessingFinished";
69 const char* const SIGNAL_TOUCHED = "touched";
70 const char* const SIGNAL_TOUCH = "touch";
71 const char* const SIGNAL_WHEEL_EVENT = "wheelEvent";
72 const char* const SIGNAL_CONTEXT_LOST = "contextLost";
73 const char* const SIGNAL_CONTEXT_REGAINED = "contextRegained";
74 const char* const SIGNAL_SCENE_CREATED = "sceneCreated";
76 TypeRegistration mType( typeid(Dali::Stage), typeid(Dali::BaseHandle), NULL );
78 SignalConnectorType signalConnector1( mType, SIGNAL_KEY_EVENT, &Stage::DoConnectSignal );
79 SignalConnectorType signalConnector2( mType, SIGNAL_EVENT_PROCESSING_FINISHED, &Stage::DoConnectSignal );
80 SignalConnectorType signalConnector3( mType, SIGNAL_TOUCHED, &Stage::DoConnectSignal );
81 SignalConnectorType signalConnector4( mType, SIGNAL_WHEEL_EVENT, &Stage::DoConnectSignal );
82 SignalConnectorType signalConnector5( mType, SIGNAL_CONTEXT_LOST, &Stage::DoConnectSignal );
83 SignalConnectorType signalConnector6( mType, SIGNAL_CONTEXT_REGAINED, &Stage::DoConnectSignal );
84 SignalConnectorType signalConnector7( mType, SIGNAL_SCENE_CREATED, &Stage::DoConnectSignal );
85 SignalConnectorType signalConnector8( mType, SIGNAL_KEY_EVENT_GENERATED, &Stage::DoConnectSignal );
86 SignalConnectorType signalConnector9( mType, SIGNAL_TOUCH, &Stage::DoConnectSignal );
88 } // unnamed namespace
90 StagePtr Stage::New( AnimationPlaylist& playlist,
91 PropertyNotificationManager& propertyNotificationManager,
92 SceneGraph::UpdateManager& updateManager,
93 NotificationManager& notificationManager,
94 Integration::RenderController& renderController )
96 return StagePtr( new Stage( playlist, propertyNotificationManager, updateManager, notificationManager, renderController ) );
99 void Stage::Initialize( bool renderToFbo )
101 mRenderToFbo = renderToFbo;
102 mObjectRegistry = ObjectRegistry::New();
104 // Create the ordered list of layers
105 mLayerList = LayerList::New( mUpdateManager );
107 // The stage owns the default layer
108 mRootLayer = Layer::NewRoot( *mLayerList, mUpdateManager );
109 mRootLayer->SetName("RootLayer");
110 // The root layer needs to have a fixed resize policy (as opposed to the default USE_NATURAL_SIZE).
111 // This stops actors parented to the stage having their relayout requests propagating
112 // up to the root layer, and down through other children unnecessarily.
113 mRootLayer->SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
115 // Create the default camera actor first; this is needed by the RenderTaskList
116 CreateDefaultCameraActor();
118 // Create the list of render-tasks
119 mRenderTaskList = RenderTaskList::New();
121 // Create the default render-task (don't need the returned handle)
122 mRenderTaskList->CreateTask( mRootLayer.Get(), mDefaultCamera.Get() );
125 void Stage::Uninitialize()
127 // Remove actors added to SystemOverlay
128 delete mSystemOverlay;
129 mSystemOverlay = NULL;
133 // its enough to release the handle so the object is released
134 // don't need to remove it from root actor as root actor will delete the object
135 mDefaultCamera.Reset();
140 // we are closing down so just delete the root, no point emit disconnect
141 // signals or send messages to update
145 if( mRenderTaskList )
147 mRenderTaskList.Reset();
151 StagePtr Stage::GetCurrent()
153 StagePtr stage( NULL );
154 // no checking in this version
155 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
158 stage = tls->GetCurrentStage();
163 bool Stage::IsInstalled()
165 return ThreadLocalStorage::Created();
168 ObjectRegistry& Stage::GetObjectRegistry()
170 return *mObjectRegistry;
173 void Stage::RegisterObject( Dali::BaseObject* object )
175 mObjectRegistry->RegisterObject( object );
178 void Stage::UnregisterObject( Dali::BaseObject* object )
180 mObjectRegistry->UnregisterObject( object );
183 Layer& Stage::GetRootActor()
188 AnimationPlaylist& Stage::GetAnimationPlaylist()
190 return mAnimationPlaylist;
193 PropertyNotificationManager& Stage::GetPropertyNotificationManager()
195 return mPropertyNotificationManager;
198 void Stage::Add( Actor& actor )
200 mRootLayer->Add( actor );
203 void Stage::Remove( Actor& actor )
205 mRootLayer->Remove( actor );
208 void Stage::SurfaceResized( float width, float height )
210 if( ( fabsf( width - mSurfaceSize.width ) > Math::MACHINE_EPSILON_1000 ) || ( fabsf( height - mSurfaceSize.height ) > Math::MACHINE_EPSILON_1000 ) )
212 mSurfaceSize.width = width;
213 mSurfaceSize.height = height;
215 // Internally we want to report the actual size of the stage.
217 mSize.height = height - static_cast<float>( mTopMargin );
219 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
220 mDefaultCamera->SetPerspectiveProjection( mSurfaceSize );
222 // Adjust the camera height to allow for top-margin
223 SetDefaultCameraPosition();
225 mRootLayer->SetSize( mSize.width, mSize.height );
227 // Repeat for SystemOverlay actors
230 // Note that the SystemOverlay has a separate camera, configured for the full surface-size.
231 // This will remain unaffected by changes in SetDefaultCameraPosition()
232 mSystemOverlay->GetImpl()->SetSize( width, height );
235 SetDefaultSurfaceRectMessage( mUpdateManager, Rect<int32_t>( 0, 0, static_cast<int32_t>( width ), static_cast<int32_t>( height ) ) ); // truncated
237 // if single render task to screen then set its viewport parameters
238 if( 1 == mRenderTaskList->GetTaskCount() )
240 Dali::RenderTask defaultRenderTask = mRenderTaskList->GetTask( 0u );
242 if(!defaultRenderTask.GetTargetFrameBuffer())
244 defaultRenderTask.SetViewport( Viewport( 0, 0, static_cast<int32_t>( width ), static_cast<int32_t>( height ) ) ); // truncated
250 Dali::FrameBuffer frameBuffer = Dali::FrameBuffer::New( static_cast<uint32_t>( width ), static_cast<uint32_t>( height ), Dali::FrameBuffer::Attachment::NONE );
251 Dali::Texture texture = Dali::Texture::New( Dali::TextureType::TEXTURE_2D, Dali::Pixel::RGB888, static_cast<uint32_t>( width ), static_cast<uint32_t>( height ) );
252 frameBuffer.AttachColorTexture( texture );
254 Dali::RenderTask defaultRenderTask = mRenderTaskList->GetTask( 0u );
255 defaultRenderTask.SetFrameBuffer( frameBuffer );
260 Vector2 Stage::GetSize() const
265 void Stage::SetTopMargin( uint32_t margin )
267 if (mTopMargin == margin)
273 mSize.width = mSurfaceSize.width;
274 mSize.height = mSurfaceSize.height - static_cast<float>( mTopMargin );
276 // Adjust the camera height to allow for top-margin
277 SetDefaultCameraPosition();
279 mRootLayer->SetSize( mSize.width, mSize.height );
282 RenderTaskList& Stage::GetRenderTaskList() const
284 return *mRenderTaskList;
287 void Stage::CreateDefaultCameraActor()
289 // The default camera attributes and position is such that
290 // children of the default layer, can be positioned at (0,0) and
291 // be at the top-left of the viewport.
292 mDefaultCamera = CameraActor::New( Size::ZERO );
293 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
294 Add(*(mDefaultCamera.Get()));
297 void Stage::SetDefaultCameraPosition()
299 mDefaultCamera->SetY( -(static_cast<float>(mTopMargin) * 0.5f) );
302 Actor& Stage::GetDefaultRootActor()
307 CameraActor& Stage::GetDefaultCameraActor()
309 return *mDefaultCamera;
312 uint32_t Stage::GetLayerCount() const
314 return mLayerList->GetLayerCount();
317 Dali::Layer Stage::GetLayer( uint32_t depth ) const
319 return Dali::Layer(mLayerList->GetLayer( depth ));
322 Dali::Layer Stage::GetRootLayer() const
324 return Dali::Layer( mRootLayer.Get() );
327 LayerList& Stage::GetLayerList()
332 Integration::SystemOverlay& Stage::GetSystemOverlay()
334 // Lazily create system-level if requested
335 if( !mSystemOverlay )
337 mSystemOverlay = new Integration::SystemOverlay( SystemOverlay::New( *this ) );
338 DALI_ASSERT_ALWAYS( NULL != mSystemOverlay && "Failed to create system overlay" );
340 mSystemOverlay->GetImpl()->SetSize( mSize.width, mSize.height );
343 return *mSystemOverlay;
346 SystemOverlay* Stage::GetSystemOverlayInternal()
348 SystemOverlay* overlay( NULL );
352 overlay = mSystemOverlay->GetImpl();
358 void Stage::SetBackgroundColor(Vector4 color)
360 // Cache for public GetBackgroundColor()
361 mBackgroundColor = color;
363 // Send message to change color in next frame
364 SetBackgroundColorMessage( mUpdateManager, color );
367 Vector4 Stage::GetBackgroundColor() const
369 return mBackgroundColor;
372 Vector2 Stage::GetDpi() const
377 void Stage::SetDpi(Vector2 dpi)
382 void Stage::KeepRendering( float durationSeconds )
384 // Send message to keep rendering
385 KeepRenderingMessage( mUpdateManager, durationSeconds );
388 void Stage::SetRenderingBehavior( DevelStage::Rendering renderingBehavior )
390 if( mRenderingBehavior != renderingBehavior )
392 // Send message to change the rendering behavior
393 SetRenderingBehaviorMessage( mUpdateManager, renderingBehavior );
395 mRenderingBehavior = renderingBehavior;
399 DevelStage::Rendering Stage::GetRenderingBehavior() const
401 return mRenderingBehavior;
404 bool Stage::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
406 bool connected( true );
407 Stage* stage = static_cast< Stage* >(object); // TypeRegistry guarantees that this is the correct type.
409 if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
411 stage->KeyEventSignal().Connect( tracker, functor );
413 else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT_GENERATED ) )
415 stage->KeyEventGeneratedSignal().Connect( tracker, functor );
417 else if( 0 == strcmp( signalName.c_str(), SIGNAL_EVENT_PROCESSING_FINISHED ) )
419 stage->EventProcessingFinishedSignal().Connect( tracker, functor );
421 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCHED ) )
423 stage->TouchedSignal().Connect( tracker, functor );
425 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCH ) )
427 stage->TouchSignal().Connect( tracker, functor );
429 else if( 0 == strcmp( signalName.c_str(), SIGNAL_WHEEL_EVENT ) )
431 stage->WheelEventSignal().Connect( tracker, functor );
433 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_LOST ) )
435 stage->ContextLostSignal().Connect( tracker, functor );
437 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_REGAINED ) )
439 stage->ContextRegainedSignal().Connect( tracker, functor );
441 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCENE_CREATED ) )
443 stage->SceneCreatedSignal().Connect( tracker, functor );
447 // signalName does not match any signal
454 void Stage::EmitKeyEventSignal(const KeyEvent& event)
456 // Emit the key event signal when no actor in the stage has gained the key input focus
458 mKeyEventSignal.Emit( event );
461 bool Stage::EmitKeyEventGeneratedSignal(const KeyEvent& event)
463 // Emit the KeyEventGenerated signal when KeyEvent is generated
465 return mKeyEventGeneratedSignal.Emit( event );
468 void Stage::EmitEventProcessingFinishedSignal()
470 mEventProcessingFinishedSignal.Emit();
473 void Stage::EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch )
475 mTouchedSignal.Emit( touchEvent );
476 mTouchSignal.Emit( touch );
479 void Stage::EmitWheelEventSignal(const WheelEvent& event)
481 // Emit the wheel event signal when no actor in the stage has gained the wheel input focus
483 mWheelEventSignal.Emit( event );
486 void Stage::EmitSceneCreatedSignal()
488 mSceneCreatedSignal.Emit();
491 Dali::Stage::KeyEventSignalType& Stage::KeyEventSignal()
493 return mKeyEventSignal;
496 Dali::DevelStage::KeyEventGeneratedSignalType& Stage::KeyEventGeneratedSignal()
498 return mKeyEventGeneratedSignal;
501 void Stage::AddFrameCallback( FrameCallbackInterface& frameCallback, Actor& rootActor )
503 DALI_ASSERT_ALWAYS( ( ! FrameCallbackInterface::Impl::Get( frameCallback ).IsConnectedToSceneGraph() )
504 && "FrameCallbackInterface implementation already added" );
506 // Create scene-graph object and transfer to UpdateManager
507 OwnerPointer< SceneGraph::FrameCallback > transferOwnership( SceneGraph::FrameCallback::New( frameCallback ) );
508 AddFrameCallbackMessage( mUpdateManager, transferOwnership, rootActor.GetNode() );
511 void Stage::RemoveFrameCallback( FrameCallbackInterface& frameCallback )
513 FrameCallbackInterface::Impl::Get( frameCallback ).Invalidate();
514 RemoveFrameCallbackMessage( mUpdateManager, frameCallback );
517 Dali::Stage::EventProcessingFinishedSignalType& Stage::EventProcessingFinishedSignal()
519 return mEventProcessingFinishedSignal;
522 Dali::Stage::TouchedSignalType& Stage::TouchedSignal()
524 DALI_LOG_WARNING( "Deprecated. Use TouchSignal() instead.\n" );
525 return mTouchedSignal;
528 Dali::Stage::TouchSignalType& Stage::TouchSignal()
533 Dali::Stage::WheelEventSignalType& Stage::WheelEventSignal()
535 return mWheelEventSignal;
538 Dali::Stage::ContextStatusSignal& Stage::ContextLostSignal()
540 return mContextLostSignal;
543 Dali::Stage::ContextStatusSignal& Stage::ContextRegainedSignal()
545 return mContextRegainedSignal;
548 Dali::Stage::SceneCreatedSignalType& Stage::SceneCreatedSignal()
550 return mSceneCreatedSignal;
553 void Stage::NotifyContextLost()
555 mContextLostSignal.Emit();
558 void Stage::NotifyContextRegained()
560 mContextRegainedSignal.Emit();
564 void Stage::RequestRebuildDepthTree()
566 DALI_LOG_INFO(gLogFilter, Debug::General, "RequestRebuildDepthTree()\n");
567 mDepthTreeDirty = true;
570 void Stage::RebuildDepthTree()
572 // If the depth tree needs rebuilding, do it in this frame only.
573 if( mDepthTreeDirty )
575 DALI_LOG_INFO(gLogFilter, Debug::Concise, "RebuildDepthTree() dirty:T\n");
577 ActorPtr actor( mRootLayer.Get() );
578 actor->RebuildDepthTree();
579 mDepthTreeDirty = false;
584 Stage::Stage( AnimationPlaylist& playlist,
585 PropertyNotificationManager& propertyNotificationManager,
586 SceneGraph::UpdateManager& updateManager,
587 NotificationManager& notificationManager,
588 Integration::RenderController& renderController )
589 : mAnimationPlaylist( playlist ),
590 mPropertyNotificationManager( propertyNotificationManager ),
591 mUpdateManager( updateManager ),
592 mNotificationManager( notificationManager ),
593 mRenderController( renderController ),
594 mSize( Vector2::ZERO ),
595 mSurfaceSize( Vector2::ZERO ),
596 mBackgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
598 mDpi( Vector2::ZERO ),
599 mSystemOverlay( NULL ),
601 mKeyEventGeneratedSignal(),
602 mEventProcessingFinishedSignal(),
606 mContextLostSignal(),
607 mContextRegainedSignal(),
608 mSceneCreatedSignal(),
609 mRenderingBehavior( DevelStage::Rendering::IF_REQUIRED ),
610 mDepthTreeDirty( false ),
611 mForceNextUpdate( false ),
612 mRenderToFbo( false )
616 SceneGraph::UpdateManager& Stage::GetUpdateManager()
618 return mUpdateManager;
621 Integration::RenderController& Stage::GetRenderController()
623 return mRenderController;
626 uint32_t* Stage::ReserveMessageSlot( uint32_t size, bool updateScene )
628 return mUpdateManager.ReserveMessageSlot( size, updateScene );
631 BufferIndex Stage::GetEventBufferIndex() const
633 return mUpdateManager.GetEventBufferIndex();
636 void Stage::ForceNextUpdate()
638 mForceNextUpdate = true;
641 bool Stage::IsNextUpdateForced()
643 bool nextUpdateForced = mForceNextUpdate;
644 mForceNextUpdate = false;
645 return nextUpdateForced;
650 delete mSystemOverlay;
652 mObjectRegistry.Reset();
655 } // namespace Internal