1 #ifndef __DALI_INTERNAL_STAGE_H__
2 #define __DALI_INTERNAL_STAGE_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/object/ref-object.h>
23 #include <dali/public-api/common/stage.h>
24 #include <dali/public-api/object/base-object.h>
25 #include <dali/integration-api/context-notifier.h>
26 #include <dali/internal/common/owner-pointer.h>
27 #include <dali/internal/event/actors/layer-impl.h>
28 #include <dali/internal/event/common/event-thread-services.h>
29 #include <dali/internal/event/common/object-registry-impl.h>
30 #include <dali/internal/event/common/stage-def.h>
31 #include <dali/internal/event/render-tasks/render-task-defaults.h>
32 #include <dali/internal/update/manager/update-manager.h>
33 #include <dali/public-api/common/view-mode.h>
34 #include <dali/public-api/math/vector2.h>
35 #include <dali/public-api/math/vector3.h>
36 #include <dali/public-api/math/vector4.h>
37 #include <dali/public-api/render-tasks/render-task.h>
57 class AnimationPlaylist;
58 class PropertyNotificationManager;
66 * Implementation of Stage
68 class Stage : public BaseObject, public RenderTaskDefaults, public Integration::ContextNotifierInterface, public EventThreadServices
74 * @param[in] playlist for animations
75 * @param[in] propertyNotificationManager
76 * @param[in] updateManager
77 * @param[in] notificationManager
79 static StagePtr New( AnimationPlaylist& playlist,
80 PropertyNotificationManager& propertyNotificationManager,
81 SceneGraph::UpdateManager& updateManager,
82 NotificationManager& notificationManager );
85 * Initialize the stage.
90 * Uninitialize the stage.
95 * @copydoc Dali::Stage::GetCurrent()
96 * @note this version is for internal usage so it does not assert
98 static StagePtr GetCurrent();
101 * @copydoc Dali::Stage::IsInstalled().
103 static bool IsInstalled();
106 * @copydoc Dali::Stage::GetObjectRegistry()
108 ObjectRegistry& GetObjectRegistry();
111 * Retrieve the root actor (not publically accessible).
112 * @return The root actor.
114 Layer& GetRootActor();
117 * Returns the animation playlist.
118 * @return reference to the animation playlist.
120 AnimationPlaylist& GetAnimationPlaylist();
123 * Returns the property notification manager.
124 * @return reference to the property notification manager.
126 PropertyNotificationManager& GetPropertyNotificationManager();
128 // Root actor accessors
131 * @copydoc Dali::Stage::Add()
133 void Add( Actor& actor );
136 * @copydoc Dali::Stage::Remove()
138 void Remove( Actor& actor );
141 * Used to calculate the size of the stage and indirectly, the root actor.
142 * @param [in] width The new surface width.
143 * @param [in] height The new surface height.
145 void SurfaceResized( float width, float height );
148 * Sets the top margin size.
149 * Available stage size is reduced by this size.
150 * The stage is located below the size at the top of the display
151 * initial size is zero before it is assigned
152 * @param[in] margin margin size
154 void SetTopMargin( unsigned int margin );
157 * Returns the size of the Stage in pixels as a Vector.
158 * The x component will be the width of the Stage in pixels
159 * The y component will be the height of the Stage in pixels
160 * @return The size of the Stage as a Vector.
162 Vector2 GetSize() const;
165 * @copydoc Dali::Stage::GetRenderTaskList()
167 RenderTaskList& GetRenderTaskList() const;
170 * Create a default camera actor
172 void CreateDefaultCameraActor();
175 * Set position of default camera for current stage size
177 void SetDefaultCameraPosition();
180 * From RenderTaskDefaults; retrieve the default root actor.
181 * @return The default root actor.
183 virtual Actor& GetDefaultRootActor();
186 * From RenderTaskDefaults; retrieve the default camera actor.
187 * @return The default camera actor.
189 virtual CameraActor& GetDefaultCameraActor();
194 * @copydoc Dali::Stage::GetLayerCount()
196 unsigned int GetLayerCount() const;
199 * @copydoc Dali::Stage::GetLayer()
201 Dali::Layer GetLayer( unsigned int depth ) const;
204 * @copydoc Dali::Stage::GetRootLayer()
206 Dali::Layer GetRootLayer() const;
209 * Retrieve the ordered list of on-stage layers.
210 * @return The layer-list.
212 LayerList& GetLayerList();
214 // System-level overlay actors
217 * @copydoc Dali::Integration::Core::GetSystemOverlay()
219 Integration::SystemOverlay& GetSystemOverlay();
222 * Retrieve the internal implementation of the SystemOverlay.
223 * @return The implementation, or NULL if this has never been requested from Integration API.
225 SystemOverlay* GetSystemOverlayInternal();
230 * @copydoc Dali::Integration::Core::SetViewMode()
232 void SetViewMode( ViewMode viewMode );
235 * @copydoc Dali::Integration::Core::GetViewMode()
237 ViewMode GetViewMode() const;
240 * @copydoc Dali::Integration::Core::SetStereoBase()
242 void SetStereoBase( float stereoBase );
245 * @copydoc Dali::Integration::Core::GetStereoBase()
247 float GetStereoBase() const;
252 * As one virtual keyboard per stage, the stage will hold a pointer to the Actor currently
253 * set to receive keyboard input.
254 * @param[in] actor to receive keyboard input
256 void SetKeyboardFocusActor( Actor* actor );
259 * Get the actor that is currently set to receive keyboard inputs
260 * @return Pointer to the actor set to receive keyboard inputs.
262 Actor* GetKeyboardFocusActor() const;
265 * Removes the given actor from keyboard focus so it will no longer receive key events from keyboard.
266 * @param [in] actor which should be removed from focus.
268 void RemoveActorFromKeyFocus( Actor* actor );
273 * @copydoc Dali::Stage::SetBackgroundColor
275 void SetBackgroundColor(Vector4 color);
278 * @copydoc Dali::Stage::GetBackgroundColor
280 Vector4 GetBackgroundColor() const;
283 * @copydoc Dali::Stage::GetDpi
285 Vector2 GetDpi() const;
288 * Sets horizontal and vertical pixels per inch value that is used by the display
289 * @param[in] dpi Horizontal and vertical dpi value
291 void SetDpi( Vector2 dpi );
293 NotificationManager& GetNotificationManager()
295 return mNotificationManager;
299 * @copydoc Dali::Stage::KeepRendering()
301 void KeepRendering( float durationSeconds );
304 * Used by the EventProcessor to emit key event signals.
305 * @param[in] event The key event.
307 void EmitKeyEventSignal(const KeyEvent& event);
310 * Emits the event processing finished signal.
312 * @see Dali::Stage::SignalEventProcessingFinished()
314 void EmitEventProcessingFinishedSignal();
317 * Emits the touched signal.
318 * @param[in] touchEvent The touch event details (Old API).
319 * @param[in] touch The touch event details.
321 void EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch );
324 * Used by the EventProcessor to emit wheel event signals.
325 * @param[in] event The wheel event.
327 void EmitWheelEventSignal( const WheelEvent& event );
330 * Emits the scene created.
332 void EmitSceneCreatedSignal();
335 * @copydoc Dali::Stage::KeyEventSignal()
337 Dali::Stage::KeyEventSignalType& KeyEventSignal();
340 * @copydoc Dali::Stage::SignalEventProcessingFinished()
342 Dali::Stage::EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
345 * @copydoc Dali::Stage::TouchedSignal()
347 Dali::Stage::TouchedSignalType& TouchedSignal();
350 * @copydoc Dali::Stage::TouchSignal()
352 Dali::Stage::TouchSignalType& TouchSignal();
355 * @copydoc Dali::Stage::WheelEventSignal()
357 Dali::Stage::WheelEventSignalType& WheelEventSignal();
360 * @copydoc Dali::Stage::ContextLostSignal()
362 Dali::Stage::ContextStatusSignal& ContextLostSignal();
365 * @copydoc Dali::Stage::ContextRegainedSignal()
367 Dali::Stage::ContextStatusSignal& ContextRegainedSignal();
370 * @copydoc Dali::Stage::SceneCreatedSignal()
372 Dali::Stage::SceneCreatedSignalType& SceneCreatedSignal();
375 * Connects a callback function with the object's signals.
376 * @param[in] object The object providing the signal.
377 * @param[in] tracker Used to disconnect the signal.
378 * @param[in] signalName The signal to connect to.
379 * @param[in] functor A newly allocated FunctorDelegate.
380 * @return True if the signal was connected.
381 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
383 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
385 private: // Implementation of ContextNotificationInterface:
388 * @copydoc Dali::Integration::NotifyContextLost();
390 virtual void NotifyContextLost();
393 * @copydoc Dali::Integration::NotifyContextRegained();
395 virtual void NotifyContextRegained();
397 public: // Implementation of EventThreadServices
400 * @copydoc EventThreadServices::RegisterObject
402 virtual void RegisterObject( BaseObject* object);
405 * @copydoc EventThreadServices::UnregisterObject
407 virtual void UnregisterObject( BaseObject* object);
410 * @copydoc EventThreadServices::GetUpdateManager
412 virtual SceneGraph::UpdateManager& GetUpdateManager();
415 * @copydoc EventThreadServices::ReserveMessageSlot
417 virtual unsigned int* ReserveMessageSlot( std::size_t size, bool updateScene );
420 * @copydoc EventThreadServices::GetEventBufferIndex
422 virtual BufferIndex GetEventBufferIndex() const;
427 * Protected constructor; see also Stage::New()
429 Stage( AnimationPlaylist& playlist,
430 PropertyNotificationManager& propertyNotificationManager,
431 SceneGraph::UpdateManager& updateManager,
432 NotificationManager& notificationManager );
435 * A reference counted object may only be deleted by calling Unreference()
441 // For 'Fire and forget' animation support
442 AnimationPlaylist& mAnimationPlaylist;
444 PropertyNotificationManager& mPropertyNotificationManager;
446 SceneGraph::UpdateManager& mUpdateManager;
448 NotificationManager& mNotificationManager;
450 // The stage-size may be less than surface-size (reduced by top-margin)
452 Vector2 mSurfaceSize;
454 // Cached for public GetBackgroundColor()
455 Vector4 mBackgroundColor;
459 // Ordered list of currently on-stage layers
460 OwnerPointer<LayerList> mLayerList;
462 IntrusivePtr<CameraActor> mDefaultCamera;
467 unsigned int mTopMargin;
470 // The object registry
471 ObjectRegistryPtr mObjectRegistry;
473 // The list of render-tasks
474 IntrusivePtr<RenderTaskList> mRenderTaskList;
476 Dali::RenderTask mRightRenderTask;
477 IntrusivePtr<CameraActor> mRightCamera;
478 Dali::RenderTask mLeftRenderTask;
479 IntrusivePtr<CameraActor> mLeftCamera;
481 Integration::SystemOverlay* mSystemOverlay; ///< SystemOverlay stage access
483 // The key event signal
484 Dali::Stage::KeyEventSignalType mKeyEventSignal;
486 // The event processing finished signal
487 Dali::Stage::EventProcessingFinishedSignalType mEventProcessingFinishedSignal;
489 // The touched signals
490 Dali::Stage::TouchedSignalType mTouchedSignal;
491 Dali::Stage::TouchSignalType mTouchSignal;
493 // The wheel event signal
494 Dali::Stage::WheelEventSignalType mWheelEventSignal;
496 Dali::Stage::ContextStatusSignal mContextLostSignal;
497 Dali::Stage::ContextStatusSignal mContextRegainedSignal;
499 Dali::Stage::SceneCreatedSignalType mSceneCreatedSignal;
502 } // namespace Internal
504 // Helpers for public-api forwarding methods
506 inline Internal::Stage& GetImplementation(Dali::Stage& stage)
508 DALI_ASSERT_ALWAYS( stage && "Stage handle is empty" );
510 BaseObject& handle = stage.GetBaseObject();
512 return static_cast<Internal::Stage&>(handle);
515 inline const Internal::Stage& GetImplementation(const Dali::Stage& stage)
517 DALI_ASSERT_ALWAYS( stage && "Stage handle is empty" );
519 const BaseObject& handle = stage.GetBaseObject();
521 return static_cast<const Internal::Stage&>(handle);
526 #endif // __DALI_INTERNAL_STAGE_H__