dali/integration-api/scene.h

   1 #ifndef DALI_SCENE_H
   2 #define DALI_SCENE_H
   3
   4 /*
   5  * Copyright (c) 2019 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/handle.h>
  23 #include <dali/public-api/math/vector2.h>
  24
  25 namespace Dali
  26 {
  27
  28 class Actor;
  29 struct KeyEvent;
  30 class Layer;
  31 class RenderTaskList;
  32 class TouchData;
  33 struct WheelEvent;
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37   class Scene;
  38 }
  39
  40 namespace Integration
  41 {
  42
  43 class RenderSurface;
  44 struct Event;
  45
  46 /**
  47  * @brief
  48  *
  49  * Scene creates a "world" that can be bound to a surface for rendering.
  50  *
  51  */
  52 class DALI_CORE_API Scene : public BaseHandle
  53 {
  54 public:
  55   typedef Signal< void () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type
  56   typedef Signal< void (const Dali::KeyEvent&) > KeyEventSignalType; ///< Key event signal type
  57   typedef Signal< bool (const Dali::KeyEvent&) > KeyEventGeneratedSignalType; ///< key event generated signal type
  58   typedef Signal< void (const Dali::TouchData&) > TouchSignalType; ///< Touch signal type
  59   typedef Signal< void (const Dali::WheelEvent&) > WheelEventSignalType; ///< Touched signal type
  60
  61   /**
  62    * @brief Create an initialized Scene handle.
  63    *
  64    * @param[in] size The size of the scene in pixels as a Vector
  65    *
  66    * @return a handle to a newly allocated Dali resource.
  67    */
  68   static Scene New( const Size& size );
  69
  70   /**
  71    * @brief Downcast an Object handle to Scene handle.
  72    *
  73    * If handle points to a Scene object the downcast produces
  74    * valid handle. If not the returned handle is left uninitialized.
  75    * @param[in] handle to An object
  76    * @return handle to a Scene object or an uninitialized handle
  77    */
  78   static Scene DownCast( BaseHandle handle );
  79
  80   /**
  81    * @brief Create an uninitialized Scene handle.
  82    *
  83    * This can be initialized with Scene::New(). Calling member
  84    * functions with an uninitialized Dali::Object is not allowed.
  85    */
  86   Scene();
  87
  88   /**
  89    * @brief Destructor
  90    *
  91    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  92    */
  93   ~Scene();
  94
  95   /**
  96    * @brief This copy constructor is required for (smart) pointer semantics.
  97    *
  98    * @param [in] handle A reference to the copied handle
  99    */
 100   Scene(const Scene& handle);
 101
 102   /**
 103    * @brief This assignment operator is required for (smart) pointer semantics.
 104    *
 105    * @param [in] rhs  A reference to the copied handle
 106    * @return A reference to this
 107    */
 108   Scene& operator=(const Scene& rhs);
 109
 110   /**
 111    * @brief Adds a child Actor to the Scene.
 112    *
 113    * The child will be referenced.
 114    * @param[in] actor The child
 115    * @pre The actor has been initialized.
 116    * @pre The actor does not have a parent.
 117    */
 118   void Add(Actor actor);
 119
 120   /**
 121    * @brief Removes a child Actor from the Scene.
 122    *
 123    * The child will be unreferenced.
 124    * @param[in] actor The child
 125    * @pre The actor has been added to the stage.
 126    */
 127   void Remove(Actor actor);
 128
 129   /**
 130    * @brief Returns the size of the Scene in pixels as a Vector.
 131    *
 132    * The x component will be the width of the Scene in pixels.
 133    * The y component will be the height of the Scene in pixels.
 134    *
 135    * @return The size of the Scene as a Vector
 136    */
 137   Size GetSize() const;
 138
 139   /**
 140    * Sets horizontal and vertical pixels per inch value that is used by the display
 141    * @param[in] dpi Horizontal and vertical dpi value
 142    */
 143   void SetDpi( Vector2 dpi );
 144
 145   /**
 146    * @brief Retrieves the DPI of the display device to which the scene is connected.
 147    *
 148    * @return The horizontal and vertical DPI
 149    */
 150   Vector2 GetDpi() const;
 151
 152   /**
 153    * @brief Retrieves the list of render-tasks.
 154    *
 155    * @return A valid handle to a RenderTaskList
 156    */
 157   Dali::RenderTaskList GetRenderTaskList() const;
 158
 159   /**
 160    * @brief Returns the Scene's Root Layer.
 161    *
 162    * @return The root layer
 163    */
 164   Layer GetRootLayer() const;
 165
 166   /**
 167    * @brief Queries the number of on-stage layers.
 168    *
 169    * Note that a default layer is always provided (count >= 1).
 170    * @return The number of layers
 171    */
 172   uint32_t GetLayerCount() const;
 173
 174   /**
 175    * @brief Retrieves the layer at a specified depth.
 176    *
 177    * @param[in] depth The depth
 178    * @return The layer found at the given depth
 179    * @pre Depth is less than layer count; see GetLayerCount().
 180    */
 181   Layer GetLayer( uint32_t depth ) const;
 182
 183   /**
 184    * @brief Binds the rendering surface to the scene
 185    *
 186    * @return The root layer
 187    */
 188   void SetSurface( Integration::RenderSurface& surface );
 189
 190   /**
 191    * @brief Gets the rendering surface bound to the scene
 192    *
 193    * @return The render surface
 194    */
 195   Integration::RenderSurface* GetSurface() const;
 196
 197   /**
 198    * @brief Retrieve the Scene that the given actor belongs to.
 199    * @return The Scene.
 200    */
 201   static Integration::Scene Get( Actor actor );
 202
 203   /**
 204    * This function is called when an event is queued.
 205    * @param[in] event A event to queue.
 206    */
 207   void QueueEvent( const Integration::Event& event );
 208
 209   /**
 210    * This function is called by Core when events are processed.
 211    */
 212   void ProcessEvents();
 213
 214   /**
 215    * @brief This signal is emitted just after the event processing is finished.
 216    *
 217    * @return The signal to connect to
 218    */
 219   EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
 220
 221   /**
 222    * @brief This signal is emitted when key event is received.
 223    *
 224    * A callback of the following type may be connected:
 225    * @code
 226    *   void YourCallbackName(const KeyEvent& event);
 227    * @endcode
 228    * @return The signal to connect to
 229    */
 230   KeyEventSignalType& KeyEventSignal();
 231
 232   /**
 233    * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
 234    *
 235    * @return The return is true if KeyEvent is consumed, otherwise false.
 236    */
 237   KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
 238
 239   /**
 240    * @brief This signal is emitted when the screen is touched and when the touch ends
 241    * (i.e. the down & up touch events only).
 242    *
 243    * If there are multiple touch points, then this will be emitted when the first touch occurs and
 244    * then when the last finger is lifted.
 245    * An interrupted event will also be emitted (if it occurs).
 246    * A callback of the following type may be connected:
 247    * @code
 248    *   void YourCallbackName( TouchData event );
 249    * @endcode
 250    *
 251    * @return The touch signal to connect to
 252    * @note Motion events are not emitted.
 253    */
 254   TouchSignalType& TouchSignal();
 255
 256   /**
 257    * @brief This signal is emitted when wheel event is received.
 258    *
 259    * A callback of the following type may be connected:
 260    * @code
 261    *   void YourCallbackName(const WheelEvent& event);
 262    * @endcode
 263    * @return The signal to connect to
 264    */
 265   WheelEventSignalType& WheelEventSignal();
 266
 267 public: // Not intended for application developers
 268
 269   /**
 270    * @brief This constructor is used by Dali::New() methods.
 271    *
 272    * @param[in] scene A pointer to an internal Scene resource
 273    */
 274   explicit DALI_INTERNAL Scene(Internal::Scene* scene);
 275 };
 276
 277 } // namespace Integration
 278
 279 } // namespace Dali
 280
 281 #endif // DALI_SCENE_H