1 #ifndef DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H
2 #define DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H
5 * Copyright (c) 2019 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.
24 #include <dali/public-api/object/base-object.h>
25 #include <dali/public-api/common/intrusive-ptr.h>
26 #include <dali/integration-api/scene.h>
27 #include <dali/integration-api/events/key-event-integ.h>
28 #include <dali/integration-api/events/point.h>
29 #include <dali/integration-api/events/touch-event-combiner.h>
32 #ifdef DALI_ADAPTOR_COMPILATION
33 #include <dali/integration-api/render-surface-interface.h>
34 #include <dali/integration-api/scene-holder.h>
36 #include <dali/integration-api/adaptors/render-surface-interface.h>
37 #include <dali/integration-api/adaptors/scene-holder.h>
69 using SceneHolderPtr = IntrusivePtr< SceneHolder >;
72 * @brief SceneHolder creates a Scene for rendering.
74 class DALI_ADAPTOR_API SceneHolder : public BaseObject
80 * @copydoc Dali::Integration::SceneHolder::Add
82 void Add( Dali::Actor actor );
85 * @copydoc Dali::Integration::SceneHolder::Remove
87 void Remove( Dali::Actor actor );
90 * @copydoc Dali::Integration::SceneHolder::GetRootLayer
92 Dali::Layer GetRootLayer() const;
95 * @brief Gets the window name.
96 * @return The name of the window
98 std::string GetName() const;
101 * @brief Retrieve the unique ID of the window.
104 uint32_t GetId() const;
107 * @brief Retrieve the Scene.
110 Dali::Integration::Scene GetScene();
113 * @brief Set the render surface
114 * @param[in] surface The render surface
116 void SetSurface( Dali::RenderSurfaceInterface* surface );
119 * @brief Called when the surface set is resized.
121 void SurfaceResized( bool forceUpdate );
124 * @brief Get the render surface
125 * @return The render surface
127 Dali::RenderSurfaceInterface* GetSurface() const;
130 * @brief Set the adaptor to the scene holder
131 * @param[in] adaptor An initialized adaptor
133 void SetAdaptor( Dali::Adaptor& adaptor );
136 * @copydoc Dali::Integration::SceneHolder::SetBackgroundColor
138 void SetBackgroundColor( const Dali::Vector4& color );
141 * @copydoc Dali::Integration::SceneHolder::GetBackgroundColor
143 Vector4 GetBackgroundColor() const;
146 * @brief Pause the rendering of the scene holder.
151 * @brief Resume the rendering of the scene holder (from pause).
156 * @copydoc Dali::Integration::SceneHolder::FeedTouchPoint
158 void FeedTouchPoint( Dali::Integration::Point& point, int timeStamp );
161 * @copydoc Dali::Integration::SceneHolder::FeedWheelEvent
163 void FeedWheelEvent( Dali::Integration::WheelEvent& wheelEvent );
166 * @copydoc Dali::Integration::SceneHolder::FeedKeyEvent
168 void FeedKeyEvent( Dali::Integration::KeyEvent& keyEvent );
171 * @copydoc Dali::Integration::SceneHolder::Get()
173 static Dali::Integration::SceneHolder Get( Dali::Actor actor );
176 * @copydoc Dali::Integration::SceneHolder::KeyEventSignal()
178 Dali::Integration::SceneHolder::KeyEventSignalType& KeyEventSignal() { return mScene.KeyEventSignal(); }
181 * @copydoc Dali::Integration::SceneHolder::KeyEventGeneratedSignal()
183 Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& KeyEventGeneratedSignal() { return mScene.KeyEventGeneratedSignal(); }
186 * @copydoc Dali::Integration::SceneHolder::TouchSignal()
188 Dali::Integration::SceneHolder::TouchSignalType& TouchSignal() { return mScene.TouchSignal(); }
191 * @copydoc Dali::Integration::SceneHolder::WheelEventSignal()
193 Dali::Integration::SceneHolder::WheelEventSignalType& WheelEventSignal() { return mScene.WheelEventSignal(); }
195 public: // The following methods can be overridden if required
198 * @brief Returns whether the Scene is visible or not.
199 * @return True if the Scene is visible, false otherwise.
201 virtual bool IsVisible() const;
203 public: // The following methods must be overridden
206 * @copydoc Dali::Integration::SceneHolder::GetNativeHandle
208 virtual Dali::Any GetNativeHandle() const = 0;
216 SceneHolder(const SceneHolder&) = delete;
219 SceneHolder& operator=(const SceneHolder& rhs) = delete;
224 virtual ~SceneHolder();
226 private: // The following methods can be overridden if required
229 * @brief Called by the base class to inform deriving classes that the adaptor has been set.
230 * @param[in] adaptor The adaptor
232 virtual void OnAdaptorSet( Dali::Adaptor& adaptor ) {};
235 * @brief Called by the base class to inform deriving classes that a new surface has been set.
236 * @param[in] surface The new render surface
238 virtual void OnSurfaceSet( Dali::RenderSurfaceInterface* surface ) {};
241 * @brief Called by the base class to inform deriving classes that we are being paused.
243 virtual void OnPause() {};
246 * @brief Called by the base class to inform deriving classes that we are resuming from a paused state.
248 virtual void OnResume() {};
251 * Recalculate the touch position if required
252 * @param[in,out] point The touch point
254 virtual void RecalculateTouchPosition( Integration::Point& point ) {};
259 * Resets the event handling.
265 static uint32_t mSceneHolderCounter; ///< A counter to track the SceneHolder creation
267 class SceneHolderLifeCycleObserver;
268 std::unique_ptr< SceneHolderLifeCycleObserver > mLifeCycleObserver; ///< The adaptor life cycle observer
272 uint32_t mId; ///< A unique ID to identify the SceneHolder starting from 0
273 Dali::Integration::Scene mScene; ///< The Scene
274 std::string mName; ///< The name of the SceneHolder
276 std::unique_ptr< Dali::RenderSurfaceInterface > mSurface; ///< The window rendering surface
277 Adaptor* mAdaptor; ///< The adaptor
279 Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
281 bool mAdaptorStarted:1; ///< Whether the adaptor has started or not
282 bool mVisible:1; ///< Whether the scene is visible or not
289 // Get impl of handle
290 inline Internal::Adaptor::SceneHolder& GetImplementation( Dali::Integration::SceneHolder& sceneHolder )
292 DALI_ASSERT_ALWAYS( sceneHolder && "SceneHolder handle is empty" );
293 Dali::RefObject& object = sceneHolder.GetBaseObject();
294 return static_cast<Internal::Adaptor::SceneHolder&>( object );
297 inline const Internal::Adaptor::SceneHolder& GetImplementation( const Dali::Integration::SceneHolder& sceneHolder )
299 DALI_ASSERT_ALWAYS( sceneHolder && "SceneHolder handle is empty" );
300 const Dali::RefObject& object = sceneHolder.GetBaseObject();
301 return static_cast<const Internal::Adaptor::SceneHolder&>( object );
306 #endif // DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H