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 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
33 #include <dali/integration-api/adaptor-framework/scene-holder.h>
64 using SceneHolderPtr = IntrusivePtr< SceneHolder >;
67 * @brief SceneHolder creates a Scene for rendering.
69 class DALI_ADAPTOR_API SceneHolder : public BaseObject
75 * @copydoc Dali::Integration::SceneHolder::Add
77 void Add( Dali::Actor actor );
80 * @copydoc Dali::Integration::SceneHolder::Remove
82 void Remove( Dali::Actor actor );
85 * @copydoc Dali::Integration::SceneHolder::GetRootLayer
87 Dali::Layer GetRootLayer() const;
90 * @brief Gets the window name.
91 * @return The name of the window
93 std::string GetName() const;
96 * @brief Retrieve the unique ID of the window.
99 uint32_t GetId() const;
102 * @brief Retrieve the Scene.
105 Dali::Integration::Scene GetScene();
108 * @brief Set the render surface
109 * @param[in] surface The render surface
111 void SetSurface( Dali::RenderSurfaceInterface* surface );
114 * @brief Called when the surface set is resized.
116 void SurfaceResized();
119 * @brief Get the render surface
120 * @return The render surface
122 Dali::RenderSurfaceInterface* GetSurface() const;
125 * @brief Set the adaptor to the scene holder
126 * @param[in] adaptor An initialized adaptor
128 void SetAdaptor( Dali::Adaptor& adaptor );
131 * @copydoc Dali::Integration::SceneHolder::SetBackgroundColor
133 void SetBackgroundColor( const Dali::Vector4& color );
136 * @copydoc Dali::Integration::SceneHolder::GetBackgroundColor
138 Vector4 GetBackgroundColor() const;
141 * @brief Pause the rendering of the scene holder.
146 * @brief Resume the rendering of the scene holder (from pause).
151 * @copydoc Dali::Integration::SceneHolder::FeedTouchPoint
153 void FeedTouchPoint( Dali::Integration::Point& point, int timeStamp );
156 * @copydoc Dali::Integration::SceneHolder::FeedWheelEvent
158 void FeedWheelEvent( Dali::Integration::WheelEvent& wheelEvent );
161 * @copydoc Dali::Integration::SceneHolder::FeedKeyEvent
163 void FeedKeyEvent( Dali::Integration::KeyEvent& keyEvent );
166 * @copydoc Dali::Integration::SceneHolder::Get()
168 static Dali::Integration::SceneHolder Get( Dali::Actor actor );
171 * @copydoc Dali::Integration::SceneHolder::KeyEventSignal()
173 Dali::Integration::SceneHolder::KeyEventSignalType& KeyEventSignal() { return mScene.KeyEventSignal(); }
176 * @copydoc Dali::Integration::SceneHolder::KeyEventGeneratedSignal()
178 Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& KeyEventGeneratedSignal() { return mScene.KeyEventGeneratedSignal(); }
181 * @copydoc Dali::Integration::SceneHolder::TouchSignal()
183 Dali::Integration::SceneHolder::TouchSignalType& TouchSignal() { return mScene.TouchSignal(); }
186 * @copydoc Dali::Integration::SceneHolder::WheelEventSignal()
188 Dali::Integration::SceneHolder::WheelEventSignalType& WheelEventSignal() { return mScene.WheelEventSignal(); }
190 public: // The following methods can be overridden if required
193 * @brief Returns whether the Scene is visible or not.
194 * @return True if the Scene is visible, false otherwise.
196 virtual bool IsVisible() const;
198 public: // The following methods must be overridden
201 * @copydoc Dali::Integration::SceneHolder::GetNativeHandle
203 virtual Dali::Any GetNativeHandle() const = 0;
211 SceneHolder(const SceneHolder&) = delete;
214 SceneHolder& operator=(const SceneHolder& rhs) = delete;
219 virtual ~SceneHolder();
221 private: // The following methods can be overridden if required
224 * @brief Called by the base class to inform deriving classes that the adaptor has been set.
225 * @param[in] adaptor The adaptor
227 virtual void OnAdaptorSet( Dali::Adaptor& adaptor ) {};
230 * @brief Called by the base class to inform deriving classes that a new surface has been set.
231 * @param[in] surface The new render surface
233 virtual void OnSurfaceSet( Dali::RenderSurfaceInterface* surface ) {};
236 * @brief Called by the base class to inform deriving classes that we are being paused.
238 virtual void OnPause() {};
241 * @brief Called by the base class to inform deriving classes that we are resuming from a paused state.
243 virtual void OnResume() {};
246 * Recalculate the touch position if required
247 * @param[in,out] point The touch point
249 virtual void RecalculateTouchPosition( Integration::Point& point ) {};
254 * Resets the event handling.
260 static uint32_t mSceneHolderCounter; ///< A counter to track the SceneHolder creation
262 class SceneHolderLifeCycleObserver;
263 std::unique_ptr< SceneHolderLifeCycleObserver > mLifeCycleObserver; ///< The adaptor life cycle observer
267 uint32_t mId; ///< A unique ID to identify the SceneHolder starting from 0
268 Dali::Integration::Scene mScene; ///< The Scene
269 std::string mName; ///< The name of the SceneHolder
271 std::unique_ptr< Dali::RenderSurfaceInterface > mSurface; ///< The window rendering surface
272 Adaptor* mAdaptor; ///< The adaptor
274 Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
276 bool mAdaptorStarted:1; ///< Whether the adaptor has started or not
277 bool mVisible:1; ///< Whether the scene is visible or not
284 // Get impl of handle
285 inline Internal::Adaptor::SceneHolder& GetImplementation( Dali::Integration::SceneHolder& sceneHolder )
287 DALI_ASSERT_ALWAYS( sceneHolder && "SceneHolder handle is empty" );
288 Dali::RefObject& object = sceneHolder.GetBaseObject();
289 return static_cast<Internal::Adaptor::SceneHolder&>( object );
292 inline const Internal::Adaptor::SceneHolder& GetImplementation( const Dali::Integration::SceneHolder& sceneHolder )
294 DALI_ASSERT_ALWAYS( sceneHolder && "SceneHolder handle is empty" );
295 const Dali::RefObject& object = sceneHolder.GetBaseObject();
296 return static_cast<const Internal::Adaptor::SceneHolder&>( object );
301 #endif // DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H