1 #ifndef DALI_SCENE3D_INTERNAL_SCENE_VIEW_H
2 #define DALI_SCENE3D_INTERNAL_SCENE_VIEW_H
5 * Copyright (c) 2023 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-toolkit/internal/visuals/image/image-visual.h>
23 #include <dali-toolkit/public-api/controls/control-impl.h>
24 #include <dali-toolkit/public-api/image-loader/async-image-loader.h>
25 #include <dali/public-api/actors/camera-actor.h>
26 #include <dali/public-api/actors/layer.h>
27 #include <dali/public-api/adaptor-framework/window.h>
28 #include <dali/public-api/animation/animation.h>
29 #include <dali/public-api/object/weak-handle.h>
30 #include <dali/public-api/render-tasks/render-task.h>
31 #include <dali/public-api/rendering/frame-buffer.h>
32 #include <dali/public-api/rendering/texture.h>
35 #include <dali-scene3d/public-api/controls/scene-view/scene-view.h>
36 #include <dali-scene3d/internal/common/environment-map-load-task.h>
37 #include <dali-scene3d/internal/common/image-based-light-observer.h>
48 * @brief Impl class for SceneView.
50 class SceneView : public Dali::Toolkit::Internal::Control
54 * @brief Creates a new SceneView.
56 * @return A public handle to the newly allocated SceneView.
58 static Dali::Scene3D::SceneView New();
61 * @copydoc SceneView::AddCamera()
63 void AddCamera(Dali::CameraActor camera);
66 * @copydoc SceneView::RemoveCamera()
68 void RemoveCamera(CameraActor camera);
71 * @copydoc SceneView::GetCameraCount()
73 uint32_t GetCameraCount() const;
76 * @copydoc SceneView::GetSelectedCamera()
78 CameraActor GetSelectedCamera() const;
81 * @copydoc SceneView::GetCamera()
83 CameraActor GetCamera(uint32_t index) const;
86 * @copydoc SceneView::GetCamera()
88 CameraActor GetCamera(const std::string& name) const;
91 * @copydoc SceneView::SelectCamera()
93 void SelectCamera(uint32_t index);
96 * @copydoc SceneView::SelectCamera()
98 void SelectCamera(const std::string& name);
101 * @brief Register an item.
103 * Some works(e.g, lighting) of SceneView should be propagated to the child 3D items.
104 * SceneView can avoid unnecessary tree traversal to find 3D items by storing only 3D items as a list.
106 * @param[in] item scene observer to be registered.
108 void RegisterSceneItem(Scene3D::Internal::ImageBasedLightObserver* item);
111 * @brief Unregister an item
113 * @param[in] item scene observer to be unregistered.
115 void UnregisterSceneItem(Scene3D::Internal::ImageBasedLightObserver* item);
118 * @copydoc SceneView::SetImageBasedLightSource()
120 void SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor);
123 * @copydoc SceneView::SetImageBasedLightScaleFactor()
125 void SetImageBasedLightScaleFactor(float scaleFactor);
128 * @copydoc SceneView::GetImageBasedLightScaleFactor()
130 float GetImageBasedLightScaleFactor() const;
133 * @copydoc SceneView::UseFramebuffer()
135 void UseFramebuffer(bool useFramebuffer);
138 * @copydoc SceneView::IsUsingFramebuffer()
140 bool IsUsingFramebuffer() const;
143 * @copydoc SceneView::SetSkybox()
145 void SetSkybox(const std::string& skyboxUrl, Scene3D::SceneView::SkyboxType skyboxType);
148 * @copydoc SceneView::SetSkyboxIntensity()
150 void SetSkyboxIntensity(float intensity);
153 * @copydoc SceneView::GetSkyboxIntensity()
155 float GetSkyboxIntensity() const;
158 * @copydoc SceneView::SetSkyboxOrientation()
160 void SetSkyboxOrientation(const Quaternion& orientation);
163 * @copydoc SceneView::GetSkyboxOrientation()
165 Quaternion GetSkyboxOrientation() const;
169 * @brief Constructs a new SceneView.
174 * A reference counted object may only be deleted by calling Unreference()
176 virtual ~SceneView();
180 * @copydoc CustomActorImpl::OnSceneConnection()
182 void OnSceneConnection(int depth) override;
185 * @copydoc CustomActorImpl::OnSceneDisconnection()
187 void OnSceneDisconnection() override;
190 * @copydoc Toolkit::Control::OnInitialize()
192 void OnInitialize() override;
195 * @copydoc Toolkit::Control::OnChildAdd()
197 void OnChildAdd(Actor& child) override;
200 * @copydoc Toolkit::Control::OnChildRemove()
202 void OnChildRemove(Actor& child) override;
205 * @copydoc Toolkit::Control::GetHeightForWidth()
207 float GetHeightForWidth(float width) override;
210 * @copydoc Toolkit::Control::GetWidthForHeight()
212 float GetWidthForHeight(float height) override;
215 * @copydoc Toolkit::Control::OnRelayout()
217 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
220 * @copydoc Toolkit::Control::IsResourceReady()
222 bool IsResourceReady() const override;
225 * @brief Changes main camera as a input camera
227 * @param camera CameraActor that will be a main camera of the SceneView
229 void UpdateCamera(CameraActor camera);
232 * @brief Updates RenderTask to use selected camera and to make framebuffer
234 void UpdateRenderTask();
237 * @brief Callback that will be called when window is resized.
239 void OnWindowResized(Window window, Window::WindowSize size);
242 * @brief Updates camera's projection orientation according to the screen orientation.
247 * @brief Asynchronously skybox (Equirectangular) loading finished.
249 void OnSkyboxEquirectangularLoadComplete(uint32_t loadedTaskId, PixelData pixelData);
252 * @brief Asynchronously skybox loading finished.
254 void OnSkyboxLoadComplete();
257 * @brief Asynchronously ibl diffusel image loading finished.
259 void OnIblDiffuseLoadComplete();
262 * @brief Asynchronously ibl specular image loading finished.
264 void OnIblSpecularLoadComplete();
267 * @brief Asynchronously ibl loading finished.
269 void OnIblLoadComplete();
272 * @brief Notify the changes of Ibl textures to the child items.
274 void NotifyImageBasedLightTextureChange();
277 Toolkit::Visual::Base mVisual;
279 /////////////////////////////////////////////////////////////
280 // FrameBuffer and Rendertask to render child objects as a 3D Scene
281 Dali::WeakHandle<Dali::Window> mWindow;
282 CameraActor mDefaultCamera;
283 CameraActor mSelectedCamera;
284 std::vector<CameraActor> mCameras;
285 std::vector<Scene3D::Internal::ImageBasedLightObserver*> mItems;
286 Dali::FrameBuffer mFrameBuffer;
287 Dali::Texture mTexture;
288 Dali::RenderTask mRenderTask;
290 int32_t mWindowOrientation;
292 Quaternion mSkyboxOrientation;
293 float mSkyboxIntensity{1.0f};
295 // Asynchronous Loading.
296 EnvironmentMapLoadTaskPtr mSkyboxLoadTask;
297 EnvironmentMapLoadTaskPtr mIblDiffuseLoadTask;
298 EnvironmentMapLoadTaskPtr mIblSpecularLoadTask;
299 std::string mSkyboxUrl;
300 std::string mDiffuseIblUrl;
301 std::string mSpecularIblUrl;
302 Dali::Toolkit::AsyncImageLoader mSkyboxImageLoader;
303 uint32_t mSkyboxImageId{0u};
305 Scene3D::SceneView::SkyboxType mSkyboxEnvironmentMapType{Scene3D::SceneView::SkyboxType::CUBEMAP};
306 Dali::Texture mSkyboxTexture;
307 Dali::Texture mDiffuseTexture;
308 Dali::Texture mSpecularTexture;
309 float mIblScaleFactor{1.0f};
310 bool mUseFrameBuffer{false};
311 bool mSkyboxResourceReady{true};
312 bool mIblDiffuseResourceReady{true};
313 bool mIblSpecularResourceReady{true};
314 bool mSkyboxDirty{false};
315 bool mIblDiffuseDirty{false};
316 bool mIblSpecularDirty{false};
318 // TODO : Light Source
321 } // namespace Internal
323 // Helpers for public-api forwarding methods
324 inline Dali::Scene3D::Internal::SceneView& GetImpl(Dali::Scene3D::SceneView& obj)
326 DALI_ASSERT_ALWAYS(obj);
327 Dali::RefObject& handle = obj.GetImplementation();
328 return static_cast<Dali::Scene3D::Internal::SceneView&>(handle);
331 inline const Dali::Scene3D::Internal::SceneView& GetImpl(const Dali::Scene3D::SceneView& obj)
333 DALI_ASSERT_ALWAYS(obj);
334 const Dali::RefObject& handle = obj.GetImplementation();
335 return static_cast<const Dali::Scene3D::Internal::SceneView&>(handle);
338 } // namespace Scene3D
342 #endif // DALI_SCENE3D_INTERNAL_SCENE_VIEW_H