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/integration-api/adaptor-framework/scene-holder.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/internal/common/environment-map-load-task.h>
36 #include <dali-scene3d/internal/common/light-observer.h>
37 #include <dali-scene3d/public-api/controls/scene-view/scene-view.h>
38 #include <dali-scene3d/public-api/loader/shader-manager.h>
49 * @brief Impl class for SceneView.
51 class SceneView : public Dali::Toolkit::Internal::Control
55 * @brief Creates a new SceneView.
57 * @return A public handle to the newly allocated SceneView.
59 static Dali::Scene3D::SceneView New();
62 * @copydoc SceneView::AddCamera()
64 void AddCamera(Dali::CameraActor camera);
67 * @copydoc SceneView::RemoveCamera()
69 void RemoveCamera(CameraActor camera);
72 * @copydoc SceneView::GetCameraCount()
74 uint32_t GetCameraCount() const;
77 * @copydoc SceneView::GetSelectedCamera()
79 CameraActor GetSelectedCamera() const;
82 * @copydoc SceneView::GetCamera()
84 CameraActor GetCamera(uint32_t index) const;
87 * @copydoc SceneView::GetCamera()
89 CameraActor GetCamera(const std::string& name) const;
92 * @copydoc SceneView::SelectCamera()
94 void SelectCamera(uint32_t index);
97 * @copydoc SceneView::SelectCamera()
99 void SelectCamera(const std::string& name);
102 * @brief Register an item.
104 * Some works(e.g, lighting) of SceneView should be propagated to the child 3D items.
105 * SceneView can avoid unnecessary tree traversal to find 3D items by storing only 3D items as a list.
107 * @param[in] item scene observer to be registered.
109 void RegisterSceneItem(Scene3D::Internal::LightObserver* item);
112 * @brief Unregister an item
114 * @param[in] item scene observer to be unregistered.
116 void UnregisterSceneItem(Scene3D::Internal::LightObserver* item);
119 * @copydoc SceneView::SetImageBasedLightSource()
121 void SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor);
124 * @copydoc SceneView::SetImageBasedLightScaleFactor()
126 void SetImageBasedLightScaleFactor(float scaleFactor);
129 * @copydoc SceneView::GetImageBasedLightScaleFactor()
131 float GetImageBasedLightScaleFactor() const;
134 * @brief Adds a Light object to this SceneView.
135 * Multiple light object can be added on this SceneView
136 * But the number of lights those actually turned on has limitation.
137 * Scene3D::Light::GetMaximumEnabledLightCount() method can be used to know the maximum namber.
139 * @param[in] light Light object to be added.
141 void AddLight(Scene3D::Light light);
144 * @brief Removes a Light object to this SceneView.
145 * If the light is currently turned on, and SceneView has lights more than maximum number of enabled light.
146 * One of light in queue is turned on after this light is removed.
148 * @param[in] light Light object to be removed.
150 void RemoveLight(Scene3D::Light light);
153 * @brief Set a shadow to this scene by input light.
154 * Currently, SceneView supports only one shadow.
156 * @param[in] light Light object to make shadow.
157 * @note The shadow will be drawn if the input light is turn on in current scene.
159 void SetShadow(Scene3D::Light light);
162 * @brief Removes Shadow from this SceneView.
164 * @param[in] light Light object to be removed.
166 void RemoveShadow(Scene3D::Light light);
169 * @copydoc SceneView::GetActivatedLightCount()
171 uint32_t GetActivatedLightCount() const;
174 * @copydoc SceneView::UseFramebuffer()
176 void UseFramebuffer(bool useFramebuffer);
179 * @copydoc SceneView::IsUsingFramebuffer()
181 bool IsUsingFramebuffer() const;
184 * @copydoc SceneView::SetFramebufferMultiSamplingLevel()
186 void SetFramebufferMultiSamplingLevel(uint8_t multiSamplingLevel);
189 * @copydoc SceneView::GetFramebufferMultiSamplingLevel()
191 uint8_t GetFramebufferMultiSamplingLevel() const;
194 * @copydoc SceneView::SetSkybox()
196 void SetSkybox(const std::string& skyboxUrl);
199 * @copydoc SceneView::SetSkyboxEnvironmentMapType()
201 void SetSkyboxEnvironmentMapType(Scene3D::EnvironmentMapType skyboxEnvironmentMapType);
204 * @copydoc SceneView::SetSkyboxIntensity()
206 void SetSkyboxIntensity(float intensity);
209 * @copydoc SceneView::GetSkyboxIntensity()
211 float GetSkyboxIntensity() const;
214 * @copydoc SceneView::SetSkyboxOrientation()
216 void SetSkyboxOrientation(const Quaternion& orientation);
219 * @copydoc SceneView::GetSkyboxOrientation()
221 Quaternion GetSkyboxOrientation() const;
224 * @brief Retrieves ShaderManager of this SceneView.
225 * @return ShaderManager of this SceneView.
227 Dali::Scene3D::Loader::ShaderManagerPtr GetShaderManager() const;
230 * @brief Update shader uniforms about shadow.
231 * @param[in] light Light that makes shadow.
233 void UpdateShadowUniform(Scene3D::Light light);
237 * @brief Constructs a new SceneView.
242 * A reference counted object may only be deleted by calling Unreference()
244 virtual ~SceneView();
248 * @copydoc CustomActorImpl::OnSceneConnection()
250 void OnSceneConnection(int depth) override;
253 * @copydoc CustomActorImpl::OnSceneDisconnection()
255 void OnSceneDisconnection() override;
258 * @copydoc Toolkit::Control::OnInitialize()
260 void OnInitialize() override;
263 * @copydoc Toolkit::Control::OnChildAdd()
265 void OnChildAdd(Actor& child) override;
268 * @copydoc Toolkit::Control::OnChildRemove()
270 void OnChildRemove(Actor& child) override;
273 * @copydoc Toolkit::Control::GetHeightForWidth()
275 float GetHeightForWidth(float width) override;
278 * @copydoc Toolkit::Control::GetWidthForHeight()
280 float GetWidthForHeight(float height) override;
283 * @copydoc Toolkit::Control::OnRelayout()
285 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
288 * @copydoc Toolkit::Control::IsResourceReady()
290 bool IsResourceReady() const override;
293 * @brief Changes main camera as a input camera
295 * @param camera CameraActor that will be a main camera of the SceneView
297 void UpdateCamera(CameraActor camera);
300 * @brief Updates RenderTask to use selected camera and to make framebuffer
302 void UpdateRenderTask();
305 * @brief Callback that will be called when window is resized.
307 void OnWindowResized(Window window, Window::WindowSize size);
310 * @brief Updates camera's projection orientation according to the screen orientation.
315 * @brief UpdateSkybox with skybox url and skybox environment map type.
317 * @param[in] skyboxUrl image url for skybox.
318 * @param[in] skyboxEnvironmentMapType The environment type of skybox.
320 void UpdateSkybox(const std::string& skyboxUrl, Scene3D::EnvironmentMapType skyboxEnvironmentMapType);
323 * @brief Asynchronously skybox loading finished.
325 void OnSkyboxLoadComplete();
328 * @brief Asynchronously ibl diffusel image loading finished.
330 void OnIblDiffuseLoadComplete();
333 * @brief Asynchronously ibl specular image loading finished.
335 void OnIblSpecularLoadComplete();
338 * @brief Asynchronously ibl loading finished.
340 void OnIblLoadComplete();
343 * @brief Notify the changes of Ibl textures to the child items.
345 void NotifyImageBasedLightTextureChange();
348 * @brief Update shadowMap framebuffer when the size should be changed.
349 * @param[in] shadowMapSize The size of shadowMap texture. The texture's width and hight is equal.
351 void UpdateShadowMapBuffer(uint32_t shadowMapSize);
354 Toolkit::Visual::Base mVisual;
356 /////////////////////////////////////////////////////////////
357 // FrameBuffer and Rendertask to render child objects as a 3D Scene
358 Dali::WeakHandle<Dali::Window> mWindow;
359 Integration::SceneHolder mSceneHolder;
360 CameraActor mDefaultCamera;
361 CameraActor mSelectedCamera;
362 std::vector<CameraActor> mCameras;
363 std::vector<Scene3D::Internal::LightObserver*> mItems;
364 Dali::FrameBuffer mFrameBuffer;
365 Dali::Texture mTexture;
366 Dali::RenderTask mRenderTask;
368 int32_t mWindowOrientation;
370 Quaternion mSkyboxOrientation;
371 float mSkyboxIntensity{1.0f};
372 uint8_t mFrameBufferMultiSamplingLevel{0u};
375 Dali::Scene3D::Loader::ShaderManagerPtr mShaderManager;
378 std::vector<std::pair<Scene3D::Light, bool>> mLights; // Pair of Light object and flag that denotes the light is currently activated or not.
379 Dali::FrameBuffer mShadowFrameBuffer;
380 Dali::RenderTask mShadowMapRenderTask;
381 Scene3D::Light mShadowLight;
383 // Asynchronous Loading.
384 EnvironmentMapLoadTaskPtr mSkyboxLoadTask;
385 EnvironmentMapLoadTaskPtr mIblDiffuseLoadTask;
386 EnvironmentMapLoadTaskPtr mIblSpecularLoadTask;
387 std::string mSkyboxUrl;
388 std::string mDiffuseIblUrl;
389 std::string mSpecularIblUrl;
391 Scene3D::EnvironmentMapType mSkyboxEnvironmentMapType{Scene3D::EnvironmentMapType::AUTO};
392 Dali::Texture mSkyboxTexture;
393 Dali::Texture mDiffuseTexture;
394 Dali::Texture mSpecularTexture;
395 float mIblScaleFactor{1.0f};
396 uint32_t mSpecularMipmapLevels{1u};
397 bool mUseFrameBuffer{false};
398 bool mSkyboxResourceReady{true};
399 bool mIblDiffuseResourceReady{true};
400 bool mIblSpecularResourceReady{true};
401 bool mSkyboxDirty{false};
402 bool mIblDiffuseDirty{false};
403 bool mIblSpecularDirty{false};
406 } // namespace Internal
408 // Helpers for public-api forwarding methods
409 inline Dali::Scene3D::Internal::SceneView& GetImpl(Dali::Scene3D::SceneView& obj)
411 DALI_ASSERT_ALWAYS(obj);
412 Dali::RefObject& handle = obj.GetImplementation();
413 return static_cast<Dali::Scene3D::Internal::SceneView&>(handle);
416 inline const Dali::Scene3D::Internal::SceneView& GetImpl(const Dali::Scene3D::SceneView& obj)
418 DALI_ASSERT_ALWAYS(obj);
419 const Dali::RefObject& handle = obj.GetImplementation();
420 return static_cast<const Dali::Scene3D::Internal::SceneView&>(handle);
423 } // namespace Scene3D
427 #endif // DALI_SCENE3D_INTERNAL_SCENE_VIEW_H