1 #ifndef __DALI_INTERNAL_RENDER_TASK_H__
2 #define __DALI_INTERNAL_RENDER_TASK_H__
5 * Copyright (c) 2014 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.
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>
35 class EventThreadServices;
42 class RenderTask : public Object
46 typedef Dali::RenderTask::ScreenToFrameBufferFunction ScreenToFrameBufferFunction;
49 * Creates a new RenderTask.
50 * @param[in] isSystemLevel Whether the render-task is on the system level task list.
52 static RenderTask* New( bool isSystemLevel );
55 * @copydoc Dali::RenderTask::SetSourceActor()
57 void SetSourceActor( Actor* actor );
60 * @copydoc Dali::RenderTask::GetSourceActor()
62 Actor* GetSourceActor() const;
65 * @copydoc Dali::RenderTask::SetExclusive()
67 void SetExclusive( bool exclusive );
70 * @copydoc Dali::RenderTask::IsExclusive()
72 bool IsExclusive() const;
75 * @copydoc Dali::RenderTask::SetInputEnabled()
77 void SetInputEnabled( bool enabled );
80 * @copydoc Dali::RenderTask::GetInputEnabled()
82 bool GetInputEnabled() const;
85 * @copydoc Dali::RenderTask::SetCameraActor()
87 void SetCameraActor( CameraActor* cameraActor );
90 * @copydoc Dali::RenderTask::GetCameraActor()
92 CameraActor* GetCameraActor() const;
95 * @copydoc Dali::RenderTask::SetTargetFrameBuffer()
97 void SetTargetFrameBuffer( Dali::FrameBufferImage frameBuffer );
100 * @copydoc Dali::RenderTask::GetTargetFrameBuffer
102 Dali::FrameBufferImage GetTargetFrameBuffer() const;
105 * @copydoc Dali::RenderTask::SetScreenToFrameBufferFunction
107 void SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction );
110 * @copydoc Dali::RenderTask::GetScreenToFrameBufferFunction
112 ScreenToFrameBufferFunction GetScreenToFrameBufferFunction() const;
115 * copydoc Dali::RenderTask::SetScreenToFrameBufferMappingActor
117 void SetScreenToFrameBufferMappingActor( Actor* mappingActor );
120 * copydoc Dali::RenderTask::GetScreenToFrameBufferMAppingActor
122 Actor* GetScreenToFrameBufferMappingActor() const;
125 * @copydoc Dali::RenderTask::SetViewportPosition
127 void SetViewportPosition(const Vector2& value);
130 * @copydoc Dali::RenderTask::GetCurrentViewportPosition
132 Vector2 GetCurrentViewportPosition() const;
135 * @copydoc Dali::RenderTask::SetViewportSize
137 void SetViewportSize(const Vector2& value);
140 * @copydoc Dali::RenderTask::GetCurrentViewportSize
142 Vector2 GetCurrentViewportSize() const;
145 * @copydoc Dali::RenderTask::SetViewport()
147 void SetViewport( const Viewport& viewport );
150 * @param[out] viewPort instance to copy the values into
152 void GetViewport( Viewport& viewPort ) const;
155 * @copydoc Dali::RenderTask::SetClearColor()
157 void SetClearColor( const Vector4& color );
160 * @copydoc Dali::RenderTask::GetClearColor()
162 const Vector4& GetClearColor() const;
165 * @copydoc Dali::RenderTask::SetClearEnabled()
167 void SetClearEnabled( bool enabled );
170 * @copydoc Dali::RenderTask::GetClearEnabled()
172 bool GetClearEnabled() const;
175 * @copydoc Dali::RenderTask::SetCullMode()
177 void SetCullMode( bool mode );
180 * @copydoc Dali::RenderTask::GetCullMode()
182 bool GetCullMode() const;
185 * @copydoc Dali::RenderTask::SetRefreshRate()
187 void SetRefreshRate( unsigned int refreshRate );
190 * @copydoc Dali::RenderTask::GetRefreshRate()
192 unsigned int GetRefreshRate() const;
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.
199 bool IsHittable( Vector2& screenCoords ) const;
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
206 bool TranslateCoordinates( Vector2& screenCoords ) const;
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.
212 bool IsSystemLevel() const;
215 * @copydoc Dali::RenderTask::WorldToViewport()
217 bool WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const;
220 * @copydoc Dali::RenderTask::ViewportToLocal()
222 bool ViewportToLocal(Actor* actor, float viewportX, float viewportY, float &localX, float &localY) const;
224 public: // Used by RenderTaskList, which owns the SceneGraph::RenderTasks
227 * Create the scene-graph RenderTask object.
228 * @pre CreateSceneObject has not already been called.
229 * @return A newly allocated scene-graph object; the caller takes ownership.
231 SceneGraph::RenderTask* CreateSceneObject();
234 * Retrieve the scene-graph RenderTask object.
235 * @return The scene-graph object, or NULL if this has been discarded.
237 SceneGraph::RenderTask* GetRenderTaskSceneObject();
240 * Discard the scene-graph RenderTask object.
242 void DiscardSceneObject();
244 public: // Implementation of Object
247 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
249 virtual unsigned int GetDefaultPropertyCount() const;
252 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
254 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
257 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
259 virtual const char* GetDefaultPropertyName(Property::Index index) const;
262 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
264 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
267 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
269 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
272 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
274 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
277 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
279 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
282 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
284 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
287 * @copydoc Dali::Internal::Object::SetDefaultProperty()
289 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
292 * @copydoc Dali::Internal::Object::GetDefaultProperty()
294 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
297 * @copydoc Dali::Internal::Object::GetSceneObject()
299 virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
302 * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
304 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
307 * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
309 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
314 * Query whether a Finished signal should be emitted for this render-task.
315 * This should only be called by NotificationManager, before signals are emitted.
316 * @pre The refresh rate must be REFRESH_ONCE.
317 * @post HasFinished() will return false on subsequent calls, until the render-task is processed again.
318 * @return \e true if the refresh once render task has finished. Otherwise it returns \e false.
323 * Emit the Finished signal
325 void EmitSignalFinish();
328 * @copydoc Dali::RenderTask::FinishedSignal()
330 Dali::RenderTask::RenderTaskSignalType& FinishedSignal();
333 * Connects a callback function with the object's signals.
334 * @param[in] object The object providing the signal.
335 * @param[in] tracker Used to disconnect the signal.
336 * @param[in] signalName The signal to connect to.
337 * @param[in] functor A newly allocated FunctorDelegate.
338 * @return True if the signal was connected.
339 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
341 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
346 * Construct a new RenderTask.
347 * @param[in] isSystemLevel Whether the RenderTask is on the system level task list.
349 RenderTask( bool isSystemLevel );
352 * A reference counted object may only be deleted by calling Unreference()
354 virtual ~RenderTask();
357 * Helper class for connecting Nodes to the scene-graph RenderTask
359 class Connector : public Object::Observer
371 * Create the helper class
373 Connector( Type type, RenderTask& renderTask );
376 * Non-virtual destructor; not suitable as a base object.
381 * Set the actor to be observed.
382 * @param[in] actor The actor to be observed.
384 void SetActor( Actor* actor );
387 * Update the scene-graph RenderTask with a new source/camera Node.
389 void UpdateRenderTask();
391 public: // From Object::Observer
394 * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded
396 virtual void SceneObjectAdded( Object& object );
399 * @copydoc Dali::Internal::Object::Observer::SceneObjectAdded
401 virtual void SceneObjectRemoved( Object& object );
404 * @copydoc Dali::Internal::Object::Observer::ObjectDestroyed
406 virtual void ObjectDestroyed( Object& object );
411 Connector(const Connector&);
414 Connector& operator=(const Connector& rhs);
420 RenderTask& mRenderTask;
422 Actor* mActor; ///< Raw-pointer to the actor; not owned.
427 SceneGraph::RenderTask* mSceneObject; ///< Raw-pointer to the scene-graph object; not owned.
429 Connector mSourceConnector; ///< Responsible for connecting/disconnecting source Nodes
430 Connector mCameraConnector; ///< Responsible for connecting/disconnecting camera Nodes
431 Connector mMappingConnector; /// Responsible for connecting/disconnection actor node, which used to mapping screen to frame buffer coordinate
433 Vector4 mClearColor; ///< Optional clear color
435 unsigned int mRefreshRate; ///< Determines how often the task is processed.
437 unsigned int mRefreshOnceCounter;
439 Dali::FrameBufferImage mFrameBufferImage; ///< Optional off-screen render target.
441 Dali::RenderTask::ScreenToFrameBufferFunction mScreenToFrameBufferFunction; ///< Used to convert screen to frame-buffer coordinates
443 bool mExclusive : 1; ///< True if the render-task has exclusive access to the source Nodes.
444 bool mInputEnabled : 1; ///< True if the render-task should be considered for input handling.
445 bool mClearEnabled : 1; ///< True if the render-task should be clear the color buffer.
446 bool mCullMode : 1; ///< True if the render-task's actors should be culled
447 bool mIsSystemLevel : 1; ///< True if the render-task is on the system level task list.
450 Dali::RenderTask::RenderTaskSignalType mSignalFinished; ///< Signal emmited when the render task has been processed.
453 } // namespace Internal
455 // Helpers for public-api forwarding methods
457 inline Internal::RenderTask& GetImplementation(Dali::RenderTask& task)
459 DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
461 BaseObject& handle = task.GetBaseObject();
463 return static_cast<Internal::RenderTask&>(handle);
466 inline const Internal::RenderTask& GetImplementation(const Dali::RenderTask& task)
468 DALI_ASSERT_ALWAYS(task && "RenderTask handle is empty");
470 const BaseObject& handle = task.GetBaseObject();
472 return static_cast<const Internal::RenderTask&>(handle);
477 #endif //__DALI_INTERNAL_RENDER_TASK_H__