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/common/stage-impl.h>
26 #include <dali/integration-api/system-overlay.h>
27 #include <dali/internal/event/actors/layer-impl.h>
28 #include <dali/internal/event/actors/layer-list.h>
29 #include <dali/internal/event/actors/camera-actor-impl.h>
30 #include <dali/internal/event/actor-attachments/camera-attachment-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/update/nodes/node.h>
36 #include <dali/internal/event/common/object-registry-impl.h>
37 #include <dali/integration-api/platform-abstraction.h>
38 #include <dali/public-api/common/constants.h>
39 #include <dali/public-api/render-tasks/render-task-list.h>
41 #ifdef DYNAMICS_SUPPORT
42 #include <dali/internal/event/dynamics/dynamics-world-config-impl.h>
43 #include <dali/internal/event/dynamics/dynamics-world-impl.h>
44 #include <dali/integration-api/dynamics/dynamics-factory-intf.h>
45 #include <dali/integration-api/dynamics/dynamics-world-settings.h>
48 using Dali::Internal::SceneGraph::Node;
59 const float DEFAULT_STEREO_BASE( 65.0f );
61 } // unnamed namespace
63 StagePtr Stage::New( AnimationPlaylist& playlist,
64 PropertyNotificationManager& propertyNotificationManager,
65 SceneGraph::UpdateManager& updateManager,
66 NotificationManager& notificationManager )
68 return StagePtr( new Stage( playlist, propertyNotificationManager, updateManager, notificationManager ) );
71 void Stage::Initialize()
73 mObjectRegistry = ObjectRegistry::New();
75 // Create the ordered list of layers
76 mLayerList = LayerList::New( *this, false/*not system-level*/ );
78 // The stage owns the default layer
79 mRootLayer = Layer::NewRoot( *this, *mLayerList, mUpdateManager, false/*not system-level*/ );
80 mRootLayer->SetName("RootLayer");
82 // Create the default camera actor first; this is needed by the RenderTaskList
83 CreateDefaultCameraActor();
85 // Create the list of render-tasks
86 mRenderTaskList = RenderTaskList::New( mUpdateManager, *this, false/*not system-level*/ );
88 // Create the default render-task
89 Dali::RenderTask defaultRenderTask = mRenderTaskList->CreateTask();
92 void Stage::Uninitialize()
94 // Remove actors added to SystemOverlay
95 delete mSystemOverlay;
96 mSystemOverlay = NULL;
100 Remove(*(mDefaultCamera.Get()));
105 // we are closing down so just delete the root, no point emit disconnect
106 // signals or send messages to update
111 StagePtr Stage::GetCurrent()
113 StagePtr stage( NULL );
114 // no checking in this version
115 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
118 stage = tls->GetCurrentStage();
123 bool Stage::IsInstalled()
125 return ThreadLocalStorage::Created();
128 ObjectRegistry& Stage::GetObjectRegistry()
130 return *mObjectRegistry;
133 void Stage::RegisterObject( Dali::BaseObject* object )
135 mObjectRegistry->RegisterObject( object );
138 void Stage::UnregisterObject( Dali::BaseObject* object )
140 mObjectRegistry->UnregisterObject( object );
143 Layer& Stage::GetRootActor()
148 SceneGraph::UpdateManager& Stage::GetUpdateManager()
150 return mUpdateManager;
153 EventToUpdate& Stage::GetUpdateInterface()
155 return mUpdateManager.GetEventToUpdate();
158 AnimationPlaylist& Stage::GetAnimationPlaylist()
160 return mAnimationPlaylist;
163 PropertyNotificationManager& Stage::GetPropertyNotificationManager()
165 return mPropertyNotificationManager;
168 void Stage::Add( Actor& actor )
170 mRootLayer->Add( actor );
173 void Stage::Remove( Actor& actor )
175 mRootLayer->Remove( actor );
178 void Stage::SetSize(float width, float height)
180 // Internally we want to report the actual size of the stage.
182 mSize.height = height;
184 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
185 mDefaultCamera->SetPerspectiveProjection( mSize );
187 // The depth of the stage gets set to the maximun of these values
188 mRootLayer->SetSize( mSize );
190 // Repeat for SystemOverlay actors
193 mSystemOverlay->GetImpl()->SetSize( mSize.width, mSize.height );
196 SetDefaultSurfaceRectMessage( mUpdateManager, Rect<int>( 0, 0, width, height ) );
199 Vector2 Stage::GetSize() const
204 RenderTaskList& Stage::GetRenderTaskList() const
206 return *mRenderTaskList;
209 void Stage::CreateDefaultCameraActor()
211 // The default camera attributes and position is such that
212 // children of the default layer, can be positioned at (0,0) and
213 // be at the top-left of the viewport.
214 mDefaultCamera = CameraActor::New( Size::ZERO );
215 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
216 Add(*(mDefaultCamera.Get()));
219 Actor& Stage::GetDefaultRootActor()
224 CameraActor& Stage::GetDefaultCameraActor()
226 return *mDefaultCamera;
229 unsigned int Stage::GetLayerCount() const
231 return mLayerList->GetLayerCount();
234 Dali::Layer Stage::GetLayer( unsigned int depth ) const
236 return Dali::Layer(mLayerList->GetLayer( depth ));
239 Dali::Layer Stage::GetRootLayer() const
241 return Dali::Layer( mRootLayer.Get() );
244 LayerList& Stage::GetLayerList()
249 Integration::SystemOverlay& Stage::GetSystemOverlay()
251 // Lazily create system-level if requested
252 if( !mSystemOverlay )
254 mSystemOverlay = new Integration::SystemOverlay( SystemOverlay::New( *this ) );
255 DALI_ASSERT_ALWAYS( NULL != mSystemOverlay && "Failed to create system overlay" );
257 mSystemOverlay->GetImpl()->SetSize( mSize.width, mSize.height );
260 return *mSystemOverlay;
263 SystemOverlay* Stage::GetSystemOverlayInternal()
265 SystemOverlay* overlay( NULL );
269 overlay = mSystemOverlay->GetImpl();
275 void Stage::SetViewMode( ViewMode viewMode )
277 if( mViewMode != viewMode )
279 DALI_LOG_INFO( Debug::Filter::gActor, Debug::Concise, "View mode changed from %d to %d\n", mViewMode, viewMode);
281 if( mViewMode == MONO )
283 mDefaultCamera->SetRotation( Degree( 180.0f ), Vector3::YAXIS );
284 mRenderTaskList->GetTask(0).SetSourceActor( Dali::Actor() );
286 //Create camera and RenderTask for left eye
287 mLeftCamera = CameraActor::New( Size::ZERO );
288 mLeftCamera->SetParentOrigin( ParentOrigin::CENTER );
289 mDefaultCamera->Add( *mLeftCamera.Get() );
290 mLeftRenderTask = mRenderTaskList->CreateTask();
291 mLeftRenderTask.SetCameraActor( Dali::CameraActor( mLeftCamera.Get() ) );
292 mLeftCamera->SetType( Dali::Camera::FREE_LOOK );
294 //Create camera and RenderTask for right eye
295 mRightCamera = CameraActor::New( Size::ZERO );
296 mRightCamera->SetParentOrigin( ParentOrigin::CENTER );
297 mDefaultCamera->Add( *mRightCamera.Get() );
298 mRightRenderTask = mRenderTaskList->CreateTask();
299 mRightRenderTask.SetClearColor( Vector4( 1.0f,0.0f,0.0f,1.0f));
301 mRightRenderTask.SetCameraActor( Dali::CameraActor( mRightCamera.Get() ) );
302 mRightCamera->SetType( Dali::Camera::FREE_LOOK );
306 mViewMode = viewMode;
312 // delete extra stereoscopic render tasks and cameras
313 mRenderTaskList->RemoveTask( mLeftRenderTask );
314 mDefaultCamera->Remove( *mLeftCamera.Get() );
315 mLeftRenderTask.Reset();
317 mRenderTaskList->RemoveTask( mRightRenderTask );
318 mDefaultCamera->Remove( *mRightCamera.Get() );
319 mRightRenderTask.Reset();
320 mRightCamera.Reset();
322 mDefaultCamera->SetRotation( Degree( 0.0f ), Vector3::YAXIS );
323 mDefaultCamera->SetType( Dali::Camera::LOOK_AT_TARGET );
324 mRenderTaskList->GetTask(0).SetSourceActor( Dali::Layer(mRootLayer.Get()) );
328 case STEREO_HORIZONTAL:
330 //Stereo mode with horizontal split is for landscape mode. That's the reason for the cameras being rotated
331 //Top camera renders the scene as seen from the right eye and bottom camera as seen from left.
333 //Calculate separation in pixels along vertical axis ( mStereoBase is defined in millimetres )
334 const float stereoBase( ( (mStereoBase / 25.4f) * GetDpi().y ) * 0.5f );
336 //Calculate aspect ratio
337 float aspect = mSize.width / (mSize.height * 0.5f);
339 mLeftCamera->SetPerspectiveProjection( mSize, Vector2( 0.0f,stereoBase) );
340 mLeftCamera->SetAspectRatio( aspect );
341 mLeftCamera->SetRotation( Degree(-90.0f), Vector3::ZAXIS );
342 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
343 mLeftRenderTask.SetViewport( Viewport(0, mSize.height * 0.5f, mSize.width, mSize.height * 0.5f) );
345 mRightCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, -stereoBase) );
346 mRightCamera->SetAspectRatio( aspect );
347 mRightCamera->SetRotation( Degree(-90.0f), Vector3::ZAXIS );
348 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
349 mRightRenderTask.SetViewport( Viewport(0, 0, mSize.width, mSize.height * 0.5f ) );
353 case STEREO_VERTICAL:
355 //Calculate separation in pixels along horizontal axis
356 const float stereoBase( ( (mStereoBase / 25.4f) * GetDpi().x ) * 0.5f );
358 //Recalculate fov based on viewport size
359 const float fov = 2.0f * std::atan( mSize.y / (2.0f * std::max( mSize.x*0.5f, mSize.y )) );
361 mLeftCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(stereoBase,0.0f) );
362 mLeftCamera->SetFieldOfView( fov );
363 mLeftCamera->SetRotation( Degree(0.0f), Vector3::ZAXIS );
364 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
365 mLeftRenderTask.SetViewport( Viewport(0, 0, mSize.width * 0.5f, mSize.height ) );
367 mRightCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(-stereoBase,0.0f) );
368 mRightCamera->SetFieldOfView( fov );
369 mRightCamera->SetRotation( Degree(0.0f), Vector3::ZAXIS );
370 mRightCamera->SetPosition( Vector3( -stereoBase, 0.0f, 0.0f ) );
371 mRightRenderTask.SetViewport( Viewport(mSize.width * 0.5f, 0, mSize.width * 0.5f, mSize.height ) );
375 case STEREO_INTERLACED:
383 ViewMode Stage::GetViewMode() const
388 void Stage::SetStereoBase( float stereoBase )
390 if( ! Equals( mStereoBase, stereoBase ) )
392 DALI_LOG_INFO( Debug::Filter::gActor, Debug::Concise, "old( %.2f) new(%.2f)", mStereoBase, stereoBase );
393 mStereoBase = stereoBase;
397 case STEREO_HORIZONTAL:
399 stereoBase = mStereoBase / 25.4f * GetDpi().y * 0.5f;
400 float aspect = mSize.width / (mSize.height * 0.5f);
402 mLeftCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, stereoBase) );
403 mLeftCamera->SetAspectRatio( aspect );
404 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
406 mRightCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, -stereoBase) );
407 mRightCamera->SetAspectRatio( aspect );
408 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
412 case STEREO_VERTICAL:
414 stereoBase = mStereoBase / 25.4f * GetDpi().x * 0.5f;
415 const float fov = 2.0f * std::atan( mSize.y / (2.0f * std::max( mSize.x*0.5f, mSize.y )) );
417 mLeftCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(stereoBase,0.0f) );
418 mLeftCamera->SetFieldOfView( fov );
419 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
421 mRightCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(-stereoBase,0.0f) );
422 mRightCamera->SetFieldOfView( fov );
423 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
433 float Stage::GetStereoBase() const
438 void Stage::SetBackgroundColor(Vector4 color)
440 // Cache for public GetBackgroundColor()
441 mBackgroundColor = color;
443 // Send message to change color in next frame
444 SetBackgroundColorMessage( mUpdateManager, color );
447 Vector4 Stage::GetBackgroundColor() const
449 return mBackgroundColor;
452 Vector2 Stage::GetDpi() const
457 void Stage::SetDpi(Vector2 dpi)
462 #ifdef DYNAMICS_SUPPORT
464 DynamicsNotifier& Stage::GetDynamicsNotifier()
466 return mDynamicsNotifier;
469 DynamicsWorldPtr Stage::InitializeDynamics(DynamicsWorldConfigPtr config)
471 if( !mDynamicsFactory )
473 mDynamicsFactory = ThreadLocalStorage::Get().GetPlatformAbstraction().GetDynamicsFactory();
476 if( mDynamicsFactory && !mDynamicsWorld )
478 if( mDynamicsFactory->InitializeDynamics( *(config->GetSettings()) ) )
480 mDynamicsWorld = DynamicsWorld::New();
481 mDynamicsWorld->Initialize( *this, *mDynamicsFactory, config );
484 return mDynamicsWorld;
487 DynamicsWorldPtr Stage::GetDynamicsWorld()
489 return mDynamicsWorld;
492 void Stage::TerminateDynamics()
496 mDynamicsWorld->Terminate(*this);
497 mDynamicsWorld = NULL;
501 #endif // DYNAMICS_SUPPORT
503 void Stage::KeepRendering( float durationSeconds )
505 // Send message to keep rendering
506 KeepRenderingMessage( mUpdateManager, durationSeconds );
509 void Stage::EmitKeyEventSignal(const KeyEvent& event)
511 // Emit the key event signal when no actor in the stage has gained the key input focus
513 mKeyEventSignal.Emit( event );
516 void Stage::EmitEventProcessingFinishedSignal()
518 mEventProcessingFinishedSignal.Emit();
521 void Stage::EmitTouchedSignal( const TouchEvent& touch )
523 mTouchedSignal.Emit( touch );
527 void Stage::EmitSceneCreatedSignal()
529 mSceneCreatedSignal.Emit();
532 Dali::Stage::KeyEventSignalType& Stage::KeyEventSignal()
534 return mKeyEventSignal;
537 Dali::Stage::EventProcessingFinishedSignalType& Stage::EventProcessingFinishedSignal()
539 return mEventProcessingFinishedSignal;
542 Dali::Stage::TouchedSignalType& Stage::TouchedSignal()
544 return mTouchedSignal;
547 Dali::Stage::ContextStatusSignal& Stage::ContextLostSignal()
549 return mContextLostSignal;
552 Dali::Stage::ContextStatusSignal& Stage::ContextRegainedSignal()
554 return mContextRegainedSignal;
557 Dali::Stage::SceneCreatedSignalType& Stage::SceneCreatedSignal()
559 return mSceneCreatedSignal;
562 void Stage::NotifyContextLost()
564 mContextLostSignal.Emit();
567 void Stage::NotifyContextRegained()
569 mContextRegainedSignal.Emit();
572 Stage::Stage( AnimationPlaylist& playlist,
573 PropertyNotificationManager& propertyNotificationManager,
574 SceneGraph::UpdateManager& updateManager,
575 NotificationManager& notificationManager )
576 : mAnimationPlaylist( playlist ),
577 mPropertyNotificationManager(propertyNotificationManager),
578 mUpdateManager(updateManager),
579 mNotificationManager(notificationManager),
580 mSize(Vector2::ZERO),
581 mBackgroundColor(Dali::Stage::DEFAULT_BACKGROUND_COLOR),
583 mStereoBase( DEFAULT_STEREO_BASE ),
584 #ifdef DYNAMICS_SUPPORT
585 mDynamicsFactory(NULL),
593 delete mSystemOverlay;
595 mObjectRegistry.Reset();
598 } // namespace Internal