1 #ifndef DALI_SCENE3D_INTERNAL_SCENE_VIEW_H
2 #define DALI_SCENE3D_INTERNAL_SCENE_VIEW_H
5 * Copyright (c) 2024 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/integration-api/ordered-set.h>
26 #include <dali/public-api/actors/camera-actor.h>
27 #include <dali/public-api/actors/layer.h>
28 #include <dali/public-api/adaptor-framework/window.h>
29 #include <dali/public-api/animation/animation.h>
30 #include <dali/public-api/object/weak-handle.h>
31 #include <dali/public-api/render-tasks/render-task.h>
32 #include <dali/public-api/rendering/frame-buffer.h>
33 #include <dali/public-api/rendering/texture.h>
36 #include <dali-scene3d/internal/common/environment-map-load-task.h>
37 #include <dali-scene3d/internal/common/light-observer.h>
38 #include <dali-scene3d/public-api/controls/scene-view/scene-view.h>
39 #include <dali-scene3d/public-api/loader/shader-manager.h>
50 * @brief Impl class for SceneView.
52 class SceneView : public Dali::Toolkit::Internal::Control
56 * @brief Creates a new SceneView.
58 * @return A public handle to the newly allocated SceneView.
60 static Dali::Scene3D::SceneView New();
63 * @copydoc SceneView::AddCamera()
65 void AddCamera(Dali::CameraActor camera);
68 * @copydoc SceneView::RemoveCamera()
70 void RemoveCamera(CameraActor camera);
73 * @copydoc SceneView::GetCameraCount()
75 uint32_t GetCameraCount() const;
78 * @copydoc SceneView::GetSelectedCamera()
80 CameraActor GetSelectedCamera() const;
83 * @copydoc SceneView::GetCamera()
85 CameraActor GetCamera(uint32_t index) const;
88 * @copydoc SceneView::GetCamera()
90 CameraActor GetCamera(const std::string& name) const;
93 * @copydoc SceneView::SelectCamera()
95 void SelectCamera(uint32_t index);
98 * @copydoc SceneView::SelectCamera()
100 void SelectCamera(const std::string& name);
103 * @brief Register an item.
105 * Some works(e.g, lighting) of SceneView should be propagated to the child 3D items.
106 * SceneView can avoid unnecessary tree traversal to find 3D items by storing only 3D items as a list.
108 * @param[in] item scene observer to be registered.
110 void RegisterSceneItem(Scene3D::Internal::LightObserver* item);
113 * @brief Unregister an item
115 * @param[in] item scene observer to be unregistered.
117 void UnregisterSceneItem(Scene3D::Internal::LightObserver* item);
120 * @copydoc SceneView::SetImageBasedLightSource()
122 void SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor);
125 * @copydoc SceneView::SetImageBasedLightScaleFactor()
127 void SetImageBasedLightScaleFactor(float scaleFactor);
130 * @copydoc SceneView::GetImageBasedLightScaleFactor()
132 float GetImageBasedLightScaleFactor() const;
135 * @brief Adds a Light object to this SceneView.
136 * Multiple light object can be added on this SceneView
137 * But the number of lights those actually turned on has limitation.
138 * Scene3D::Light::GetMaximumEnabledLightCount() method can be used to know the maximum namber.
140 * @param[in] light Light object to be added.
142 void AddLight(Scene3D::Light light);
145 * @brief Removes a Light object to this SceneView.
146 * If the light is currently turned on, and SceneView has lights more than maximum number of enabled light.
147 * One of light in queue is turned on after this light is removed.
149 * @param[in] light Light object to be removed.
151 void RemoveLight(Scene3D::Light light);
154 * @brief Set a shadow to this scene by input light.
155 * Currently, SceneView supports only one shadow.
157 * @param[in] light Light object to make shadow.
158 * @note The shadow will be drawn if the input light is turn on in current scene.
160 void SetShadow(Scene3D::Light light);
163 * @brief Removes Shadow from this SceneView.
165 * @param[in] light Light object to be removed.
167 void RemoveShadow(Scene3D::Light light);
170 * @copydoc SceneView::GetActivatedLightCount()
172 uint32_t GetActivatedLightCount() const;
175 * @copydoc SceneView::UseFramebuffer()
177 void UseFramebuffer(bool useFramebuffer);
180 * @copydoc SceneView::IsUsingFramebuffer()
182 bool IsUsingFramebuffer() const;
185 * @copydoc SceneView::SetResolution()
187 void SetResolution(uint32_t width, uint32_t height);
190 * @copydoc SceneView::GetResolutionWidth()
192 uint32_t GetResolutionWidth();
195 * @copydoc SceneView::GetResolutionHeight()
197 uint32_t GetResolutionHeight();
200 * @copydoc SceneView::ResetResolution()
202 void ResetResolution();
205 * @copydoc SceneView::SetFramebufferMultiSamplingLevel()
207 void SetFramebufferMultiSamplingLevel(uint8_t multiSamplingLevel);
210 * @copydoc SceneView::GetFramebufferMultiSamplingLevel()
212 uint8_t GetFramebufferMultiSamplingLevel() const;
215 * @copydoc SceneView::SetSkybox()
217 void SetSkybox(const std::string& skyboxUrl);
220 * @copydoc SceneView::SetSkyboxEnvironmentMapType()
222 void SetSkyboxEnvironmentMapType(Scene3D::EnvironmentMapType skyboxEnvironmentMapType);
225 * @copydoc SceneView::SetSkyboxIntensity()
227 void SetSkyboxIntensity(float intensity);
230 * @copydoc SceneView::GetSkyboxIntensity()
232 float GetSkyboxIntensity() const;
235 * @copydoc SceneView::SetSkyboxOrientation()
237 void SetSkyboxOrientation(const Quaternion& orientation);
240 * @copydoc SceneView::GetSkyboxOrientation()
242 Quaternion GetSkyboxOrientation() const;
245 * @brief Retrieves ShaderManager of this SceneView.
246 * @return ShaderManager of this SceneView.
248 Dali::Scene3D::Loader::ShaderManagerPtr GetShaderManager() const;
251 * @brief Updates shader uniforms about shadow.
252 * @param[in] light Light that makes shadow.
254 void UpdateShadowUniform(Scene3D::Light light);
257 * @brief Sets alpha mask url
258 * @param[in] alphaMaskUrl Url for alpha mask.
260 void SetAlphaMaskUrl(std::string& alphaMaskUrl);
263 * @brief Retrieves alpha mask url
264 * @return Alpha mask url.
266 std::string GetAlphaMaskUrl();
269 * @brief Sets mask content scale factor
270 * @param[in] maskContentScaleFactor Scale factor for mask content.
272 void SetMaskContentScaleFactor(float maskContentScaleFactor);
275 * @brief Retrieves mask content scale factor
276 * @return Scale factor for mask content.
278 float GetMaskContentScaleFactor();
281 * @brief Sets whether the rendered result will be crop to mask or not.
282 * @param[in] enableCropToMask True for crop rendered result to mask.
284 void EnableCropToMask(bool enableCropToMask);
287 * @brief Retrieves whether the crop to mask is enabled or not.
288 * @return True when rendered result is cropped to mask.
290 bool IsEnabledCropToMask();
293 * @brief Gets current RenderTask
295 Dali::RenderTask GetRenderTask();
300 * Called when a property of an object of this type is set.
301 * @param[in] object The object whose property is set.
302 * @param[in] index The property index.
303 * @param[in] value The new property value.
305 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
308 * Called to retrieve a property of an object of this type.
309 * @param[in] object The object whose property is to be retrieved.
310 * @param[in] index The property index.
311 * @return The current value of the property.
313 static Property::Value GetProperty(BaseObject* object, Property::Index index);
317 * @brief Constructs a new SceneView.
322 * A reference counted object may only be deleted by calling Unreference()
324 virtual ~SceneView();
328 * @copydoc CustomActorImpl::OnSceneConnection()
330 void OnSceneConnection(int depth) override;
333 * @copydoc CustomActorImpl::OnSceneDisconnection()
335 void OnSceneDisconnection() override;
338 * @copydoc Toolkit::Control::OnInitialize()
340 void OnInitialize() override;
343 * @copydoc Toolkit::Control::OnChildAdd()
345 void OnChildAdd(Actor& child) override;
348 * @copydoc Toolkit::Control::OnChildRemove()
350 void OnChildRemove(Actor& child) override;
353 * @copydoc Toolkit::Control::GetHeightForWidth()
355 float GetHeightForWidth(float width) override;
358 * @copydoc Toolkit::Control::GetWidthForHeight()
360 float GetWidthForHeight(float height) override;
363 * @copydoc Toolkit::Control::OnRelayout()
365 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
368 * @copydoc Toolkit::Control::IsResourceReady()
370 bool IsResourceReady() const override;
373 * @brief Changes main camera as a input camera
375 * @param camera CameraActor that will be a main camera of the SceneView
377 void UpdateCamera(CameraActor camera);
380 * @brief Updates RenderTask to use selected camera and to make framebuffer
382 void UpdateRenderTask();
385 * @brief Callback that will be called when window is resized.
387 void OnWindowResized(Window window, Window::WindowSize size);
390 * @brief Updates camera's projection orientation according to the screen orientation.
395 * @brief UpdateSkybox with skybox url and skybox environment map type.
397 * @param[in] skyboxUrl image url for skybox.
398 * @param[in] skyboxEnvironmentMapType The environment type of skybox.
400 void UpdateSkybox(const std::string& skyboxUrl, Scene3D::EnvironmentMapType skyboxEnvironmentMapType);
403 * @brief Asynchronously skybox loading finished.
405 void OnSkyboxLoadComplete();
408 * @brief Asynchronously ibl diffusel image loading finished.
410 void OnIblDiffuseLoadComplete();
413 * @brief Asynchronously ibl specular image loading finished.
415 void OnIblSpecularLoadComplete();
418 * @brief Asynchronously ibl loading finished.
420 void OnIblLoadComplete();
423 * @brief Notify the changes of Ibl textures to the child items.
425 void NotifyImageBasedLightTextureChange();
428 * @brief Update shadowMap framebuffer when the size should be changed.
429 * @param[in] shadowMapSize The size of shadowMap texture. The texture's width and hight is equal.
431 void UpdateShadowMapBuffer(uint32_t shadowMapSize);
434 Toolkit::Visual::Base mVisual;
436 /////////////////////////////////////////////////////////////
437 // FrameBuffer and Rendertask to render child objects as a 3D Scene
438 Dali::WeakHandle<Dali::Window> mWindow;
439 Integration::SceneHolder mSceneHolder;
440 CameraActor mDefaultCamera;
441 CameraActor mSelectedCamera;
442 std::vector<CameraActor> mCameras;
443 Dali::FrameBuffer mFrameBuffer;
444 Dali::Texture mTexture;
445 Dali::RenderTask mRenderTask;
447 int32_t mWindowOrientation;
449 Quaternion mSkyboxOrientation;
450 float mSkyboxIntensity{1.0f};
451 uint8_t mFrameBufferMultiSamplingLevel{0u};
453 Dali::Integration::OrderedSet<Scene3D::Internal::LightObserver, false> mLightObservers; ///< The set of items to be notified when light properties change. (not owned)
455 bool mWindowSizeChanged{false};
456 uint32_t mWindowWidth{0};
457 uint32_t mWindowHeight{0};
460 std::string mAlphaMaskUrl;
461 float mMaskContentScaleFactor{1.0f};
462 bool mCropToMask{true};
463 bool mMaskingPropertyChanged{false};
466 Dali::Scene3D::Loader::ShaderManagerPtr mShaderManager;
469 std::vector<std::pair<Scene3D::Light, bool>> mLights; // Pair of Light object and flag that denotes the light is currently activated or not.
470 Dali::FrameBuffer mShadowFrameBuffer;
471 Dali::RenderTask mShadowMapRenderTask;
472 Scene3D::Light mShadowLight;
473 Dali::Texture mShadowTexture;
475 // Asynchronous Loading.
476 EnvironmentMapLoadTaskPtr mSkyboxLoadTask;
477 EnvironmentMapLoadTaskPtr mIblDiffuseLoadTask;
478 EnvironmentMapLoadTaskPtr mIblSpecularLoadTask;
479 std::string mSkyboxUrl;
480 std::string mDiffuseIblUrl;
481 std::string mSpecularIblUrl;
483 Scene3D::EnvironmentMapType mSkyboxEnvironmentMapType{Scene3D::EnvironmentMapType::AUTO};
484 Dali::Texture mSkyboxTexture;
485 Dali::Texture mDiffuseTexture;
486 Dali::Texture mSpecularTexture;
487 float mIblScaleFactor{1.0f};
488 uint32_t mSpecularMipmapLevels{1u};
489 bool mUseFrameBuffer{false};
490 bool mSkyboxResourceReady{true};
491 bool mIblDiffuseResourceReady{true};
492 bool mIblSpecularResourceReady{true};
493 bool mSkyboxDirty{false};
494 bool mIblDiffuseDirty{false};
495 bool mIblSpecularDirty{false};
498 } // namespace Internal
500 // Helpers for public-api forwarding methods
501 inline Dali::Scene3D::Internal::SceneView& GetImpl(Dali::Scene3D::SceneView& obj)
503 DALI_ASSERT_ALWAYS(obj);
504 Dali::RefObject& handle = obj.GetImplementation();
505 return static_cast<Dali::Scene3D::Internal::SceneView&>(handle);
508 inline const Dali::Scene3D::Internal::SceneView& GetImpl(const Dali::Scene3D::SceneView& obj)
510 DALI_ASSERT_ALWAYS(obj);
511 const Dali::RefObject& handle = obj.GetImplementation();
512 return static_cast<const Dali::Scene3D::Internal::SceneView&>(handle);
515 } // namespace Scene3D
519 #endif // DALI_SCENE3D_INTERNAL_SCENE_VIEW_H