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