dali/internal/event/render-tasks/render-task-impl.h

   1 #ifndef __DALI_INTERNAL_RENDER_TASK_H__
   2 #define __DALI_INTERNAL_RENDER_TASK_H__
   3
   4 /*
   5  * Copyright (c) 2014 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/base-object.h>
  23 #include <dali/public-api/render-tasks/render-task.h>
  24 #include <dali/public-api/images/frame-buffer-image.h>
  25 #include <dali/internal/event/common/object-impl.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Internal
  31 {
  32
  33 class Actor;
  34 class CameraActor;
  35 class EventToUpdate;
  36
  37 namespace SceneGraph
  38 {
  39 class RenderTask;
  40 }
  41
  42 class RenderTask : public Object
  43 {
  44 public:
  45
  46   typedef Dali::RenderTask::ScreenToFrameBufferFunction ScreenToFrameBufferFunction;
  47
  48   /**
  49    * Creates a new RenderTask.
  50    * @param[in] isSystemLevel Whether the render-task is on the system level task list.
  51    */
  52   static RenderTask* New( bool isSystemLevel );
  53
  54   /**
  55    * @copydoc Dali::RenderTask::SetSourceActor()
  56    */
  57   void SetSourceActor( Actor* actor );
  58
  59   /**
  60    * @copydoc Dali::RenderTask::GetSourceActor()
  61    */
  62   Actor* GetSourceActor() const;
  63
  64   /**
  65    * @copydoc Dali::RenderTask::SetExclusive()
  66    */
  67   void SetExclusive( bool exclusive );
  68
  69   /**
  70    * @copydoc Dali::RenderTask::IsExclusive()
  71    */
  72   bool IsExclusive() const;
  73
  74   /**
  75    * @copydoc Dali::RenderTask::SetInputEnabled()
  76    */
  77   void SetInputEnabled( bool enabled );
  78
  79   /**
  80    * @copydoc Dali::RenderTask::GetInputEnabled()
  81    */
  82   bool GetInputEnabled() const;
  83
  84   /**
  85    * @copydoc Dali::RenderTask::SetCameraActor()
  86    */
  87   void SetCameraActor( CameraActor* cameraActor );
  88
  89   /**
  90    * @copydoc Dali::RenderTask::GetCameraActor()
  91    */
  92   CameraActor* GetCameraActor() const;
  93
  94   /**
  95    * @copydoc Dali::RenderTask::SetTargetFrameBuffer()
  96    */
  97   void SetTargetFrameBuffer( Dali::FrameBufferImage frameBuffer );
  98
  99   /**
 100    * @copydoc Dali::RenderTask::GetTargetFrameBuffer
 101    */
 102   Dali::FrameBufferImage GetTargetFrameBuffer() const;
 103
 104   /**
 105    * @copydoc Dali::RenderTask::SetScreenToFrameBufferFunction
 106    */
 107   void SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction );
 108
 109   /**
 110    * @copydoc Dali::RenderTask::GetScreenToFrameBufferFunction
 111    */
 112   ScreenToFrameBufferFunction GetScreenToFrameBufferFunction() const;
 113
 114   /**
 115    * copydoc Dali::RenderTask::SetScreenToFrameBufferMappingActor
 116    */
 117   void SetScreenToFrameBufferMappingActor( Actor* mappingActor );
 118
 119   /**
 120    * copydoc Dali::RenderTask::GetScreenToFrameBufferMAppingActor
 121    */
 122   Actor* GetScreenToFrameBufferMappingActor() const;
 123
 124   /**
 125    * @copydoc Dali::RenderTask::SetViewportPosition
 126    */
 127   void SetViewportPosition(const Vector2& value);
 128
 129   /**
 130    * @copydoc Dali::RenderTask::GetCurrentViewportPosition
 131    */
 132   Vector2 GetCurrentViewportPosition() const;
 133
 134   /**
 135    * @copydoc Dali::RenderTask::SetViewportSize
 136    */
 137   void SetViewportSize(const Vector2& value);
 138
 139   /**
 140    * @copydoc Dali::RenderTask::GetCurrentViewportSize
 141    */
 142   Vector2 GetCurrentViewportSize() const;
 143
 144   /**
 145    * @copydoc Dali::RenderTask::SetViewport()
 146    */
 147   void SetViewport( const Viewport& viewport );
 148
 149   /**
 150    * @param[out] viewPort instance to copy the values into
 151    */
 152   void GetViewport( Viewport& viewPort ) const;
 153
 154   /**
 155    * @copydoc Dali::RenderTask::SetClearColor()
 156    */
 157   void SetClearColor( const Vector4& color );
 158
 159   /**
 160    * @copydoc Dali::RenderTask::GetClearColor()
 161    */
 162   const Vector4& GetClearColor() const;
 163
 164   /**
 165    * @copydoc Dali::RenderTask::SetClearEnabled()
 166    */
 167   void SetClearEnabled( bool enabled );
 168
 169   /**
 170    * @copydoc Dali::RenderTask::GetClearEnabled()
 171    */
 172   bool GetClearEnabled() const;
 173
 174   /**
 175    * @copydoc Dali::RenderTask::SetCullMode()
 176    */
 177   void SetCullMode( bool mode );
 178
 179   /**
 180    * @copydoc Dali::RenderTask::GetCullMode()
 181    */
 182   bool GetCullMode() const;
 183
 184   /**
 185    * @copydoc Dali::RenderTask::SetRefreshRate()
 186    */
 187   void SetRefreshRate( unsigned int refreshRate );
 188
 189   /**
 190    * @copydoc Dali::RenderTask::GetRefreshRate()
 191    */
 192   unsigned int GetRefreshRate() const;
 193
 194   /**
 195    * Check if the render-task is hittable. If render task is offscreen, the screen coordinates may be translated.
 196    * @param[in,out] screenCoords The screen coordinate, which may be converted (for hit-testing actors which are rendered off-screen).
 197    * @return True the render-task can be used for input-handling; otherwise the output parameters are not valid.
 198    */
 199   bool IsHittable( Vector2& screenCoords ) const;
 200
 201   /**
 202    * Translates screen coordinates to render task coordinates for offscreen render tasks
 203    * @param[in,out] screenCoords The screen coordinates, which may be converted (for off-screen).
 204    * @return false if the conversion function decides the coordinates are not inside. returns true if there is no conversion function
 205    */
 206   bool TranslateCoordinates( Vector2& screenCoords ) const;
 207
 208   /**
 209    * Query whether the RenderTask is on the system level render-task list.
 210    * @return true, if on the system level task list, false otherwise.
 211    */
 212   bool IsSystemLevel() const;
 213
 214 public: // Used by RenderTaskList, which owns the SceneGraph::RenderTasks
 215
 216   /**
 217    * Create the scene-graph RenderTask object.
 218    * @pre CreateSceneObject has not already been called.
 219    * @return A newly allocated scene-graph object; the caller takes ownership.
 220    */
 221   SceneGraph::RenderTask* CreateSceneObject();
 222
 223   /**
 224    * Retrieve the scene-graph RenderTask object.
 225    * @return The scene-graph object, or NULL if this has been discarded.
 226    */
 227   SceneGraph::RenderTask* GetRenderTaskSceneObject();
 228
 229   /**
 230    * Discard the scene-graph RenderTask object.
 231    */
 232   void DiscardSceneObject();
 233
 234 public: // Implementation of Object
 235
 236   /**
 237    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
 238    */
 239   virtual unsigned int GetDefaultPropertyCount() const;
 240
 241   /**
 242    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
 243    */
 244   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
 245
 246   /**
 247    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
 248    */
 249   virtual const char* GetDefaultPropertyName(Property::Index index) const;
 250
 251   /**
 252    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
 253    */
 254   virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
 255
 256   /**
 257    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
 258    */
 259   virtual bool IsDefaultPropertyWritable(Property::Index index) const;
 260
 261   /**
 262    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
 263    */
 264   virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
 265
 266   /**
 267    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
 268    */
 269   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
 270
 271   /**
 272    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
 273    */
 274   virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
 275
 276   /**
 277    * @copydoc Dali::Internal::Object::SetDefaultProperty()
 278    */
 279   virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
 280
 281   /**
 282    * @copydoc Dali::Internal::Object::GetDefaultProperty()
 283    */
 284   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 285
 286   /**
 287    * @copydoc Dali::Internal::Object::GetSceneObject()
 288    */
 289   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
 290
 291   /**
 292    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
 293    */
 294   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
 295
 296   /**
 297    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
 298    */
 299   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
 300
 301 public: //signals
 302
 303   /**
 304    * Query whether a Finished signal should be emitted for this render-task.
 305    * This should only be called by NotificationManager, before signals are emitted.
 306    * @pre The refresh rate must be REFRESH_ONCE.
 307    * @post HasFinished() will return false on subsequent calls, until the render-task is processed again.
 308    * @return \e true if the refresh once render task has finished. Otherwise it returns \e false.
 309    */
 310   bool HasFinished();
 311
 312   /**
 313    * Emit the Finished signal
 314    */
 315   void EmitSignalFinish();
 316
 317   /**
 318    * @copydoc Dali::RenderTask::FinishedSignal()
 319    */
 320   Dali::RenderTask::RenderTaskSignalType& FinishedSignal();
 321
 322   /**
 323    * Connects a callback function with the object's signals.
 324    * @param[in] object The object providing the signal.
 325    * @param[in] tracker Used to disconnect the signal.
 326    * @param[in] signalName The signal to connect to.
 327    * @param[in] functor A newly allocated FunctorDelegate.
 328    * @return True if the signal was connected.
 329    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 330    */
 331   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 332
 333 protected:
 334
 335   /**
 336    * Construct a new RenderTask.
 337    * @param[in] eventToUpdate Used to send messages to the update-thread.
 338    * @param[in] isSystemLevel Whether the RenderTask is on the system level task list.
 339    */
 340   RenderTask( EventToUpdate& eventToUpdate, bool isSystemLevel );
 341
 342   /**
 343    * A reference counted object may only be deleted by calling Unreference()
 344    */
 345   virtual ~RenderTask();
 346
 347   /**
 348    * Helper class for connecting Nodes to the scene-graph RenderTask
 349    */
 350   class Connector : public Object::Observer
 351   {
 352   public:
 353
 354     enum Type
 355     {
 356       SOURCE_CONNECTOR,
 357       CAMERA_CONNECTOR,
 358       MAPPING_CONNECTOR
 359     };
 360
 361     /**
 362      * Create the helper class
 363      */
 364     Connector( Type type, RenderTask& renderTask );
 365
 366     /**
 367      * Non-virtual destructor; not suitable as a base object.
 368      */
 369     ~Connector();
 370
 371     /**
 372      * Set the actor to be observed.
 373      * @param[in] actor The actor to be observed.
 374      */
 375     void SetActor( Actor* actor );
 376
 377     /**
 378      * Update the scene-graph RenderTask with a new source/camera Node.
 379      */
 380     void UpdateRenderTask();
 381
 382   public: // From Object::Observer
 383
 384     /**
 385      * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded
 386      */
 387     virtual void SceneObjectAdded( Object& object );
 388
 389     /**
 390      * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded
 391      */
 392     virtual void SceneObjectRemoved( Object& object );
 393
 394     /**
 395      * @copydoc Dali::Internal::Object::Observer::ObjectDestroyed
 396      */
 397     virtual void ObjectDestroyed( Object& object );
 398
 399   private:
 400
 401     // Undefined
 402     Connector(const Connector&);
 403
 404     // Undefined
 405     Connector& operator=(const Connector& rhs);
 406
 407   public:
 408
 409     const Type mType;
 410
 411     RenderTask& mRenderTask;
 412
 413     Actor* mActor; ///< Raw-pointer to the actor; not owned.
 414   };
 415
 416 private:
 417
 418   EventToUpdate& mEventToUpdate;
 419
 420   SceneGraph::RenderTask* mSceneObject; ///< Raw-pointer to the scene-graph object; not owned.
 421
 422   Connector mSourceConnector; ///< Responsible for connecting/disconnecting source Nodes
 423   Connector mCameraConnector; ///< Responsible for connecting/disconnecting camera Nodes
 424   Connector mMappingConnector; /// Responsible for connecting/disconnection actor node, which used to mapping screen to frame buffer coordinate
 425
 426   Vector4 mClearColor;       ///< Optional clear color
 427
 428   unsigned int mRefreshRate; ///< Determines how often the task is processed.
 429
 430   unsigned int mRefreshOnceCounter;
 431
 432   Dali::FrameBufferImage mFrameBufferImage;  ///< Optional off-screen render target.
 433
 434   Dali::RenderTask::ScreenToFrameBufferFunction mScreenToFrameBufferFunction; ///< Used to convert screen to frame-buffer coordinates
 435
 436   bool mExclusive     : 1; ///< True if the render-task has exclusive access to the source Nodes.
 437   bool mInputEnabled  : 1; ///< True if the render-task should be considered for input handling.
 438   bool mClearEnabled  : 1; ///< True if the render-task should be clear the color buffer.
 439   bool mCullMode      : 1; ///< True if the render-task's actors should be culled
 440   bool mIsSystemLevel : 1; ///< True if the render-task is on the system level task list.
 441
 442   //Signals
 443   Dali::RenderTask::RenderTaskSignalType  mSignalFinished; ///< Signal emmited when the render task has been processed.
 444 };
 445
 446 } // namespace Internal
 447
 448 // Helpers for public-api forwarding methods
 449
 450 inline Internal::RenderTask& GetImplementation(Dali::RenderTask& task)
 451 {
 452   DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
 453
 454   BaseObject& handle = task.GetBaseObject();
 455
 456   return static_cast<Internal::RenderTask&>(handle);
 457 }
 458
 459 inline const Internal::RenderTask& GetImplementation(const Dali::RenderTask& task)
 460 {
 461   DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
 462
 463   const BaseObject& handle = task.GetBaseObject();
 464
 465   return static_cast<const Internal::RenderTask&>(handle);
 466 }
 467
 468 } // namespace Dali
 469
 470 #endif //__DALI_INTERNAL_RENDER_TASK_H__