dali/integration-api/scene.h

   1 #ifndef DALI_SCENE_H
   2 #define DALI_SCENE_H
   3
   4 /*
   5  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <memory>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/graphics-api/graphics-controller.h>
  26 #include <dali/graphics-api/graphics-render-target-create-info.h>
  27 #include <dali/public-api/common/vector-wrapper.h>
  28 #include <dali/public-api/math/vector2.h>
  29 #include <dali/public-api/math/vector4.h>
  30 #include <dali/public-api/object/handle.h>
  31
  32 namespace Dali
  33 {
  34 class Actor;
  35 class KeyEvent;
  36 class Layer;
  37 class RenderTaskList;
  38 class TouchEvent;
  39 class WheelEvent;
  40
  41 namespace Internal DALI_INTERNAL
  42 {
  43 class Scene;
  44 }
  45
  46 namespace Graphics
  47 {
  48 class RenderTarget;
  49 }
  50
  51 namespace Integration
  52 {
  53 struct Event;
  54
  55 /**
  56  * @brief
  57  *
  58  * Scene creates a "world" that can be bound to a surface for rendering.
  59  *
  60  */
  61 class DALI_CORE_API Scene : public BaseHandle
  62 {
  63 public:
  64   using EventProcessingFinishedSignalType = Signal<void()>;                        ///< Event Processing finished signal type
  65   using KeyEventSignalType                = Signal<void(const Dali::KeyEvent&)>;   ///< Key event signal type
  66   using KeyEventGeneratedSignalType       = Signal<bool(const Dali::KeyEvent&)>;   ///< key event generated signal type
  67   using TouchEventSignalType              = Signal<void(const Dali::TouchEvent&)>; ///< Touch signal type
  68   using WheelEventSignalType              = Signal<void(const Dali::WheelEvent&)>; ///< WheelEvent signal type
  69   using WheelEventGeneratedSignalType     = Signal<bool(const Dali::WheelEvent&)>; ///< WheelEvent generated signal type
  70
  71   using FrameCallbackContainer = std::vector<std::pair<std::unique_ptr<CallbackBase>, int32_t> >;
  72
  73   /**
  74    * @brief Create an initialized Scene handle.
  75    *
  76    * @param[in] size The size of the set surface for this scene
  77    * @param[in] windowOrientation The rotated angle of the set surface for this scene
  78    * @param[in] screenOrientation The rotated angle of the screen
  79    *
  80    * @return a handle to a newly allocated Dali resource.
  81    */
  82   static Scene New(Size size, int32_t windowOrientation = 0, int32_t screenOrientation = 0);
  83
  84   /**
  85    * @brief Downcast an Object handle to Scene handle.
  86    *
  87    * If handle points to a Scene object the downcast produces
  88    * valid handle. If not the returned handle is left uninitialized.
  89    * @param[in] handle to An object
  90    * @return handle to a Scene object or an uninitialized handle
  91    */
  92   static Scene DownCast(BaseHandle handle);
  93
  94   /**
  95    * @brief Create an uninitialized Scene handle.
  96    *
  97    * This can be initialized with Scene::New(). Calling member
  98    * functions with an uninitialized Dali::Object is not allowed.
  99    */
 100   Scene();
 101
 102   /**
 103    * @brief Destructor
 104    *
 105    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 106    */
 107   ~Scene();
 108
 109   /**
 110    * @brief This copy constructor is required for (smart) pointer semantics.
 111    *
 112    * @param [in] handle A reference to the copied handle
 113    */
 114   Scene(const Scene& handle);
 115
 116   /**
 117    * @brief This assignment operator is required for (smart) pointer semantics.
 118    *
 119    * @param [in] rhs  A reference to the copied handle
 120    * @return A reference to this
 121    */
 122   Scene& operator=(const Scene& rhs);
 123
 124   /**
 125    * @brief This move constructor is required for (smart) pointer semantics.
 126    *
 127    * @param [in] handle A reference to the moved handle
 128    */
 129   Scene(Scene&& handle);
 130
 131   /**
 132    * @brief This move assignment operator is required for (smart) pointer semantics.
 133    *
 134    * @param [in] rhs  A reference to the moved handle
 135    * @return A reference to this
 136    */
 137   Scene& operator=(Scene&& rhs);
 138
 139   /**
 140    * @brief Adds a child Actor to the Scene.
 141    *
 142    * The child will be referenced.
 143    * @param[in] actor The child
 144    * @pre The actor has been initialized.
 145    * @pre The actor does not have a parent.
 146    */
 147   void Add(Actor actor);
 148
 149   /**
 150    * @brief Removes a child Actor from the Scene.
 151    *
 152    * The child will be unreferenced.
 153    * @param[in] actor The child
 154    * @pre The actor has been added to the stage.
 155    */
 156   void Remove(Actor actor);
 157
 158   /**
 159    * @brief Returns the size of the Scene in pixels as a Vector.
 160    *
 161    * The x component will be the width of the Scene in pixels.
 162    * The y component will be the height of the Scene in pixels.
 163    *
 164    * @return The size of the Scene as a Vector
 165    */
 166   Size GetSize() const;
 167
 168   /**
 169    * Sets horizontal and vertical pixels per inch value that is used by the display
 170    * @param[in] dpi Horizontal and vertical dpi value
 171    */
 172   void SetDpi(Vector2 dpi);
 173
 174   /**
 175    * @brief Retrieves the DPI of the display device to which the scene is connected.
 176    *
 177    * @return The horizontal and vertical DPI
 178    */
 179   Vector2 GetDpi() const;
 180
 181   /**
 182    * @brief Sets the background color.
 183    *
 184    * @param[in] color The new background color
 185    */
 186   void SetBackgroundColor(const Vector4& color);
 187
 188   /**
 189    * @brief Gets the background color of the render　surface.
 190    *
 191    * @return The background color
 192    */
 193   Vector4 GetBackgroundColor() const;
 194
 195   /**
 196    * @brief Retrieves the list of render-tasks.
 197    *
 198    * @return A valid handle to a RenderTaskList
 199    */
 200   Dali::RenderTaskList GetRenderTaskList() const;
 201
 202   /**
 203    * @brief Returns the Scene's Root Layer.
 204    *
 205    * @return The root layer
 206    */
 207   Layer GetRootLayer() const;
 208
 209   /**
 210    * @brief Returns the Scene's Overlay Layer.
 211    * If there is no overlay layer yet, this creates the layer and an associated render task.
 212    *
 213    * @return The overlay layer
 214    */
 215   Layer GetOverlayLayer();
 216
 217   /**
 218    * @brief Queries the number of on-stage layers.
 219    *
 220    * Note that a default layer is always provided (count >= 1).
 221    * @return The number of layers
 222    */
 223   uint32_t GetLayerCount() const;
 224
 225   /**
 226    * @brief Retrieves the layer at a specified depth.
 227    *
 228    * @param[in] depth The depth
 229    * @return The layer found at the given depth
 230    * @pre Depth is less than layer count; see GetLayerCount().
 231    */
 232   Layer GetLayer(uint32_t depth) const;
 233
 234   /**
 235    * @brief Informs the scene that the set surface has been resized.
 236    *
 237    * @param[in] width The new width of the set surface
 238    * @param[in] height The new height of the set surface
 239    */
 240   void SurfaceResized(float width, float height);
 241
 242   /**
 243    * @brief Informs the scene that the surface has been replaced.
 244    */
 245   void SurfaceReplaced();
 246
 247   /**
 248    * @brief Removes the scene graph object.
 249    */
 250   void RemoveSceneObject();
 251
 252   /**
 253    * @brief Discards this Scene from the Core.
 254    */
 255   void Discard();
 256
 257   /**
 258    * @brief Sets the render target for the surface.
 259    *
 260    * @param[in] renderTarget The render target create info for the surface
 261    */
 262   void SetSurfaceRenderTarget(const Graphics::RenderTargetCreateInfo& createInfo);
 263
 264   /**
 265    * @brief Retrieve the Scene that the given actor belongs to.
 266    * @return The Scene.
 267    */
 268   static Integration::Scene Get(Actor actor);
 269
 270   /**
 271    * This function is called when an event is queued.
 272    * @param[in] event A event to queue.
 273    */
 274   void QueueEvent(const Integration::Event& event);
 275
 276   /**
 277    * This function is called by Core when events are processed.
 278    */
 279   void ProcessEvents();
 280
 281   /**
 282    * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
 283    *
 284    * @param[in] callback The function to call
 285    * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
 286    *
 287    * @note A callback of the following type may be used:
 288    * @code
 289    *   void MyFunction( int32_t frameId );
 290    * @endcode
 291    * This callback will be deleted once it is called.
 292    *
 293    * @note Ownership of the callback is passed onto this class.
 294    */
 295   void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 296
 297   /**
 298    * @brief Adds a callback that is called when the frame is displayed on the display.
 299    *
 300    * @param[in] callback The function to call
 301    * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
 302    *
 303    * @note A callback of the following type may be used:
 304    * @code
 305    *   void MyFunction( int32_t frameId );
 306    * @endcode
 307    * This callback will be deleted once it is called.
 308    *
 309    * @note Ownership of the callback is passed onto this class.
 310    */
 311   void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 312
 313   /**
 314    * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver.
 315    *
 316    * @param[out] callbacks The callback list
 317    *
 318    * @note This is called in the update thread.
 319    */
 320   void GetFrameRenderedCallback(FrameCallbackContainer& callbacks);
 321
 322   /**
 323    * @brief Gets the callback list that is called when the frame is displayed on the display.
 324    *
 325    * @param[out] callbacks The callback list
 326    *
 327    * @note This is called in the update thread.
 328    */
 329   void GetFramePresentedCallback(FrameCallbackContainer& callbacks);
 330
 331   /**
 332    * @brief Informs the scene that the set surface has been rotated.
 333    *
 334    * @param[in] width The width of rotated surface
 335    * @param[in] height The height of rotated surface
 336    * @param[in] windowOrientation the current window orientation
 337    * @param[in] screenOrientation the current screen orientation
 338    */
 339   void SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation);
 340
 341   /**
 342    * @brief Gets the current surface orientation. It gets the value from the scene object.
 343    *
 344    * @return The current surface orientation.
 345    */
 346   int32_t GetCurrentSurfaceOrientation() const;
 347
 348   /**
 349    * @brief Gets the current screen orientation. It gets the value from the scene object.
 350    *
 351    * @return The current screen orientation.
 352    */
 353   int32_t GetCurrentScreenOrientation() const;
 354
 355   /**
 356    * @brief Gets the current surface rectangle. It gets the value from the scene object.
 357    *
 358    * @return The current surface rectangle
 359    */
 360   const Rect<int32_t>& GetCurrentSurfaceRect() const;
 361
 362   /**
 363    * Query wheter the surface rect is changed or not.
 364    * @return true if the surface rect is changed.
 365    */
 366   bool IsSurfaceRectChanged() const;
 367
 368   /**
 369    * @brief Send message to acknowledge for completing window rotation with current window orientation.
 370    *
 371    * If this function is called, the message is sent to render thread, then mSurfaceRectChanged in scene-graph-scene is set with true.
 372    * After that, render thread checks whether window rotation event is received, mSurfaceRectChanged and the neccessary flag are set.
 373    * If they are all true, rotation done function is called to complete window rotation.
 374    */
 375   void SetRotationCompletedAcknowledgement();
 376
 377   /**
 378    * @brief Query wheter is set to acknowledge for completing surface rotation.
 379    * @return true it should be acknowledged.
 380    *
 381    * If SetRotationCompletedAcknowledgement() is called and the related message is received to scene-graph-scene,
 382    * then mSurfaceRectChanged in scene-graph-scene is set with true.
 383    *
 384    * When this function is called, the mSurfaceRectChanged in scene-graph-scene is return.
 385    * Then, the flag will be reset.
 386    *
 387    * @note This function should be not called the application's main thread.
 388    * Because this function should be called in windwow surface's postrender() function to complete window rotation manually.
 389    */
 390   bool IsRotationCompletedAcknowledgementSet() const;
 391
 392   /**
 393    * @brief This signal is emitted just after the event processing is finished.
 394    *
 395    * @return The signal to connect to
 396    */
 397   EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
 398
 399   /**
 400    * @brief This signal is emitted when key event is received.
 401    *
 402    * A callback of the following type may be connected:
 403    * @code
 404    *   void YourCallbackName(const KeyEvent& event);
 405    * @endcode
 406    * @return The signal to connect to
 407    */
 408   KeyEventSignalType& KeyEventSignal();
 409
 410   /**
 411    * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
 412    *
 413    * If the control already consumed key event, KeyEventProcessor do not need to Emit keyEvent.
 414    * Therefore, KeyinputManager first checks whether KeyEvent is generated as KeyEventGeneratedSignal.
 415    * After that keyEventProcessor must invoke KeyEvent only if KeyEventGeneratedSignal () is not consumed.
 416    *
 417    * A callback of the following type may be connected:
 418    * @code
 419    *   bool YourCallbackName(const KeyEvent& event);
 420    * @endcode
 421    *
 422    * @return The return is true if KeyEvent is consumed, otherwise false.
 423    */
 424   KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
 425
 426   /**
 427    * @brief The user would connect to this signal to intercept a KeyEvent at window.
 428    *
 429    * Intercepts KeyEvents in the window before dispatching KeyEvents to the control.
 430    * If a KeyEvent is consumed, no KeyEvent is delivered to the control.
 431    *
 432    * A callback of the following type may be connected:
 433    * @code
 434    *   bool YourCallbackName(const KeyEvent& event);
 435    * @endcode
 436    *
 437    * @return The return is true if KeyEvent is consumed, otherwise false.
 438    */
 439   KeyEventGeneratedSignalType& InterceptKeyEventSignal();
 440
 441   /**
 442    * @brief This signal is emitted when the screen is touched and when the touch ends
 443    * (i.e. the down & up touch events only).
 444    *
 445    * If there are multiple touch points, then this will be emitted when the first touch occurs and
 446    * then when the last finger is lifted.
 447    * An interrupted event will also be emitted (if it occurs).
 448    * A callback of the following type may be connected:
 449    * @code
 450    *   void YourCallbackName( TouchEvent event );
 451    * @endcode
 452    *
 453    * @return The touch signal to connect to
 454    * @note Motion events are not emitted.
 455    */
 456   TouchEventSignalType& TouchedSignal();
 457
 458   /**
 459    * @brief This signal is emitted when wheel event is received.
 460    *
 461    * A callback of the following type may be connected:
 462    * @code
 463    *   void YourCallbackName(const WheelEvent& event);
 464    * @endcode
 465    * @return The signal to connect to
 466    */
 467   WheelEventSignalType& WheelEventSignal();
 468
 469   /**
 470    * @brief When a custom wheel event occurs, it need to process the focused actor first.
 471    *
 472    * Therefore, KeyboardFocusManager first checks whether WheelEvent is generated as WheelEventGeneratedSignal.
 473    * After that wheelEventProcessor must invoke WheelEvent only if wheelEventGeneratedSignal () is not consumed.
 474    *
 475    * This is only valid for custom wheel events.
 476    *
 477    * A callback of the following type may be connected:
 478    * @code
 479    *   bool YourCallbackName(const WheelEvent& event);
 480    * @endcode
 481    *
 482    * @return The return is true if WheelEvent is consumed, otherwise false.
 483    */
 484   WheelEventGeneratedSignalType& WheelEventGeneratedSignal();
 485
 486 public: // Not intended for application developers
 487   /**
 488    * @brief This constructor is used by Dali::New() methods.
 489    *
 490    * @param[in] scene A pointer to an internal Scene resource
 491    */
 492   explicit DALI_INTERNAL Scene(Internal::Scene* scene);
 493 };
 494
 495 } // namespace Integration
 496
 497 } // namespace Dali
 498
 499 #endif // DALI_SCENE_H