1 #ifndef DALI_INTERNAL_STAGE_H
2 #define DALI_INTERNAL_STAGE_H
5 * Copyright (c) 2017 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/devel-api/common/stage-devel.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/integration-api/context-notifier.h>
27 #include <dali/internal/common/owner-pointer.h>
28 #include <dali/internal/event/actors/layer-impl.h>
29 #include <dali/internal/event/common/event-thread-services.h>
30 #include <dali/internal/event/common/object-registry-impl.h>
31 #include <dali/internal/event/common/stage-def.h>
32 #include <dali/internal/event/render-tasks/render-task-defaults.h>
33 #include <dali/internal/update/manager/update-manager.h>
34 #include <dali/public-api/common/view-mode.h>
35 #include <dali/public-api/math/vector2.h>
36 #include <dali/public-api/math/vector3.h>
37 #include <dali/public-api/math/vector4.h>
38 #include <dali/public-api/render-tasks/render-task.h>
48 class RenderController;
59 class AnimationPlaylist;
60 class PropertyNotificationManager;
68 * Implementation of Stage
70 class Stage : public BaseObject, public RenderTaskDefaults, public Integration::ContextNotifierInterface, public EventThreadServices
76 * @param[in] playlist for animations
77 * @param[in] propertyNotificationManager
78 * @param[in] updateManager
79 * @param[in] notificationManager
80 * @param[in] renderController
82 static StagePtr New( AnimationPlaylist& playlist,
83 PropertyNotificationManager& propertyNotificationManager,
84 SceneGraph::UpdateManager& updateManager,
85 NotificationManager& notificationManager,
86 Integration::RenderController& renderController );
89 * Initialize the stage.
90 * @param[in] renderToFbo Whether to render into a Frame Buffer Object.
92 void Initialize( bool renderToFbo );
95 * Uninitialize the stage.
100 * @copydoc Dali::Stage::GetCurrent()
101 * @note this version is for internal usage so it does not assert
103 static StagePtr GetCurrent();
106 * @copydoc Dali::Stage::IsInstalled().
108 static bool IsInstalled();
111 * @copydoc Dali::Stage::GetObjectRegistry()
113 ObjectRegistry& GetObjectRegistry();
116 * Retrieve the root actor (not publically accessible).
117 * @return The root actor.
119 Layer& GetRootActor();
122 * Returns the animation playlist.
123 * @return reference to the animation playlist.
125 AnimationPlaylist& GetAnimationPlaylist();
128 * Returns the property notification manager.
129 * @return reference to the property notification manager.
131 PropertyNotificationManager& GetPropertyNotificationManager();
133 // Root actor accessors
136 * @copydoc Dali::Stage::Add()
138 void Add( Actor& actor );
141 * @copydoc Dali::Stage::Remove()
143 void Remove( Actor& actor );
146 * Used to calculate the size of the stage and indirectly, the root actor.
147 * @param [in] width The new surface width.
148 * @param [in] height The new surface height.
150 void SurfaceResized( float width, float height );
153 * Sets the top margin size.
154 * Available stage size is reduced by this size.
155 * The stage is located below the size at the top of the display
156 * initial size is zero before it is assigned
157 * @param[in] margin margin size
159 void SetTopMargin( unsigned int margin );
162 * Returns the size of the Stage in pixels as a Vector.
163 * The x component will be the width of the Stage in pixels
164 * The y component will be the height of the Stage in pixels
165 * @return The size of the Stage as a Vector.
167 Vector2 GetSize() const;
170 * @copydoc Dali::Stage::GetRenderTaskList()
172 RenderTaskList& GetRenderTaskList() const;
175 * Create a default camera actor
177 void CreateDefaultCameraActor();
180 * Set position of default camera for current stage size
182 void SetDefaultCameraPosition();
185 * From RenderTaskDefaults; retrieve the default root actor.
186 * @return The default root actor.
188 virtual Actor& GetDefaultRootActor();
191 * From RenderTaskDefaults; retrieve the default camera actor.
192 * @return The default camera actor.
194 virtual CameraActor& GetDefaultCameraActor();
199 * @copydoc Dali::Stage::GetLayerCount()
201 unsigned int GetLayerCount() const;
204 * @copydoc Dali::Stage::GetLayer()
206 Dali::Layer GetLayer( unsigned int depth ) const;
209 * @copydoc Dali::Stage::GetRootLayer()
211 Dali::Layer GetRootLayer() const;
214 * Retrieve the ordered list of on-stage layers.
215 * @return The layer-list.
217 LayerList& GetLayerList();
219 // System-level overlay actors
222 * @copydoc Dali::Integration::Core::GetSystemOverlay()
224 Integration::SystemOverlay& GetSystemOverlay();
227 * Retrieve the internal implementation of the SystemOverlay.
228 * @return The implementation, or NULL if this has never been requested from Integration API.
230 SystemOverlay* GetSystemOverlayInternal();
235 * @copydoc Dali::Integration::Core::SetViewMode()
237 void SetViewMode( ViewMode viewMode );
240 * @copydoc Dali::Integration::Core::GetViewMode()
242 ViewMode GetViewMode() const;
245 * @copydoc Dali::Integration::Core::SetStereoBase()
247 void SetStereoBase( float stereoBase );
250 * @copydoc Dali::Integration::Core::GetStereoBase()
252 float GetStereoBase() const;
257 * As one virtual keyboard per stage, the stage will hold a pointer to the Actor currently
258 * set to receive keyboard input.
259 * @param[in] actor to receive keyboard input
261 void SetKeyboardFocusActor( Actor* actor );
264 * Get the actor that is currently set to receive keyboard inputs
265 * @return Pointer to the actor set to receive keyboard inputs.
267 Actor* GetKeyboardFocusActor() const;
270 * Removes the given actor from keyboard focus so it will no longer receive key events from keyboard.
271 * @param [in] actor which should be removed from focus.
273 void RemoveActorFromKeyFocus( Actor* actor );
278 * @copydoc Dali::Stage::SetBackgroundColor
280 void SetBackgroundColor(Vector4 color);
283 * @copydoc Dali::Stage::GetBackgroundColor
285 Vector4 GetBackgroundColor() const;
288 * @copydoc Dali::Stage::GetDpi
290 Vector2 GetDpi() const;
293 * Sets horizontal and vertical pixels per inch value that is used by the display
294 * @param[in] dpi Horizontal and vertical dpi value
296 void SetDpi( Vector2 dpi );
298 NotificationManager& GetNotificationManager()
300 return mNotificationManager;
304 * @copydoc Dali::Stage::KeepRendering()
306 void KeepRendering( float durationSeconds );
309 * Used by the EventProcessor to emit key event signals.
310 * @param[in] event The key event.
312 void EmitKeyEventSignal(const KeyEvent& event);
315 * Used by the KeyEventProcessor to emit KeyEventGenerated signals.
316 * @param[in] event The key event.
317 * @return The return is true if KeyEvent is consumed, otherwise false.
319 bool EmitKeyEventGeneratedSignal(const KeyEvent& event);
322 * Emits the event processing finished signal.
324 * @see Dali::Stage::SignalEventProcessingFinished()
326 void EmitEventProcessingFinishedSignal();
329 * Emits the touched signal.
330 * @param[in] touchEvent The touch event details (Old API).
331 * @param[in] touch The touch event details.
333 void EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch );
336 * Used by the EventProcessor to emit wheel event signals.
337 * @param[in] event The wheel event.
339 void EmitWheelEventSignal( const WheelEvent& event );
342 * Emits the scene created.
344 void EmitSceneCreatedSignal();
347 * @copydoc Dali::Stage::KeyEventSignal()
349 Dali::Stage::KeyEventSignalType& KeyEventSignal();
352 * @copydoc Dali::Stage::SignalEventProcessingFinished()
354 Dali::Stage::EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
357 * @copydoc Dali::Stage::TouchedSignal()
359 Dali::Stage::TouchedSignalType& TouchedSignal();
362 * @copydoc Dali::Stage::TouchSignal()
364 Dali::Stage::TouchSignalType& TouchSignal();
367 * @copydoc Dali::Stage::WheelEventSignal()
369 Dali::Stage::WheelEventSignalType& WheelEventSignal();
372 * @copydoc Dali::Stage::ContextLostSignal()
374 Dali::Stage::ContextStatusSignal& ContextLostSignal();
377 * @copydoc Dali::Stage::ContextRegainedSignal()
379 Dali::Stage::ContextStatusSignal& ContextRegainedSignal();
382 * @copydoc Dali::Stage::SceneCreatedSignal()
384 Dali::Stage::SceneCreatedSignalType& SceneCreatedSignal();
387 * @copydoc Dali::DevelStage::KeyEventGeneratedSignal()
389 Dali::DevelStage::KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
392 * Connects a callback function with the object's signals.
393 * @param[in] object The object providing the signal.
394 * @param[in] tracker Used to disconnect the signal.
395 * @param[in] signalName The signal to connect to.
396 * @param[in] functor A newly allocated FunctorDelegate.
397 * @return True if the signal was connected.
398 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
400 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
402 private: // Implementation of ContextNotificationInterface:
405 * @copydoc Dali::Integration::NotifyContextLost();
407 virtual void NotifyContextLost();
410 * @copydoc Dali::Integration::NotifyContextRegained();
412 virtual void NotifyContextRegained();
414 public: // Implementation of EventThreadServices
417 * @copydoc EventThreadServices::RegisterObject
419 virtual void RegisterObject( BaseObject* object);
422 * @copydoc EventThreadServices::UnregisterObject
424 virtual void UnregisterObject( BaseObject* object);
427 * @copydoc EventThreadServices::GetUpdateManager
429 virtual SceneGraph::UpdateManager& GetUpdateManager();
432 * @copydoc EventThreadServices::GetRenderController
434 virtual Integration::RenderController& GetRenderController();
437 * @copydoc EventThreadServices::ReserveMessageSlot
439 virtual unsigned int* ReserveMessageSlot( std::size_t size, bool updateScene );
442 * @copydoc EventThreadServices::GetEventBufferIndex
444 virtual BufferIndex GetEventBufferIndex() const;
447 * @copydoc EventThreadServices::ForceNextUpdate
449 virtual void ForceNextUpdate();
452 * @copydoc EventThreadServices::IsNextUpdateForced
454 virtual bool IsNextUpdateForced();
457 * Request that the depth tree is rebuilt
459 void RequestRebuildDepthTree();
462 * Rebuilds the depth tree at the end of the event frame if
463 * it was requested this frame.
465 void RebuildDepthTree();
470 * Protected constructor; see also Stage::New()
472 Stage( AnimationPlaylist& playlist,
473 PropertyNotificationManager& propertyNotificationManager,
474 SceneGraph::UpdateManager& updateManager,
475 NotificationManager& notificationManager,
476 Integration::RenderController& renderController );
479 * A reference counted object may only be deleted by calling Unreference()
485 // For 'Fire and forget' animation support
486 AnimationPlaylist& mAnimationPlaylist;
488 PropertyNotificationManager& mPropertyNotificationManager;
490 SceneGraph::UpdateManager& mUpdateManager;
492 NotificationManager& mNotificationManager;
494 Integration::RenderController& mRenderController;
496 // The stage-size may be less than surface-size (reduced by top-margin)
498 Vector2 mSurfaceSize;
500 // Cached for public GetBackgroundColor()
501 Vector4 mBackgroundColor;
505 // Ordered list of currently on-stage layers
506 OwnerPointer<LayerList> mLayerList;
508 IntrusivePtr<CameraActor> mDefaultCamera;
513 unsigned int mTopMargin;
516 // The object registry
517 ObjectRegistryPtr mObjectRegistry;
519 // The list of render-tasks
520 IntrusivePtr<RenderTaskList> mRenderTaskList;
522 Dali::RenderTask mRightRenderTask;
523 IntrusivePtr<CameraActor> mRightCamera;
524 Dali::RenderTask mLeftRenderTask;
525 IntrusivePtr<CameraActor> mLeftCamera;
527 Integration::SystemOverlay* mSystemOverlay; ///< SystemOverlay stage access
529 // The key event signal
530 Dali::Stage::KeyEventSignalType mKeyEventSignal;
531 Dali::DevelStage::KeyEventGeneratedSignalType mKeyEventGeneratedSignal;
533 // The event processing finished signal
534 Dali::Stage::EventProcessingFinishedSignalType mEventProcessingFinishedSignal;
536 // The touched signals
537 Dali::Stage::TouchedSignalType mTouchedSignal;
538 Dali::Stage::TouchSignalType mTouchSignal;
540 // The wheel event signal
541 Dali::Stage::WheelEventSignalType mWheelEventSignal;
543 Dali::Stage::ContextStatusSignal mContextLostSignal;
544 Dali::Stage::ContextStatusSignal mContextRegainedSignal;
546 Dali::Stage::SceneCreatedSignalType mSceneCreatedSignal;
548 bool mDepthTreeDirty:1; ///< True if the depth tree needs recalculating
549 bool mForceNextUpdate:1; ///< True if the next rendering is really required.
550 bool mRenderToFbo:1; ///< Whether to render to a Frame Buffer Object.
553 } // namespace Internal
555 // Helpers for public-api forwarding methods
557 inline Internal::Stage& GetImplementation(Dali::Stage& stage)
559 DALI_ASSERT_ALWAYS( stage && "Stage handle is empty" );
561 BaseObject& handle = stage.GetBaseObject();
563 return static_cast<Internal::Stage&>(handle);
566 inline const Internal::Stage& GetImplementation(const Dali::Stage& stage)
568 DALI_ASSERT_ALWAYS( stage && "Stage handle is empty" );
570 const BaseObject& handle = stage.GetBaseObject();
572 return static_cast<const Internal::Stage&>(handle);
577 #endif // DALI_INTERNAL_STAGE_H