2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-scene3d/internal/controls/scene-view/scene-view-impl.h>
22 #include <dali-toolkit/dali-toolkit.h>
23 #include <dali-toolkit/devel-api/controls/control-devel.h>
24 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
25 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
26 #include <dali-toolkit/public-api/image-loader/image-url.h>
27 #include <dali-toolkit/public-api/image-loader/image.h>
28 #include <dali-toolkit/public-api/image-loader/sync-image-loader.h>
29 #include <dali/devel-api/actors/camera-actor-devel.h>
30 #include <dali/devel-api/adaptor-framework/window-devel.h>
31 #include <dali/devel-api/common/stage.h>
32 #include <dali/devel-api/rendering/frame-buffer-devel.h>
33 #include <dali/integration-api/debug.h>
34 #include <dali/public-api/math/math-utils.h>
35 #include <dali/public-api/object/type-registry-helper.h>
36 #include <dali/public-api/object/type-registry.h>
37 #include <string_view>
40 #include <dali-scene3d/internal/controls/model/model-impl.h>
41 #include <dali-scene3d/internal/graphics/builtin-shader-extern-gen.h>
42 #include <dali-scene3d/public-api/loader/cube-map-loader.h>
56 return Scene3D::SceneView::New();
59 // Setup properties, signals and actions using the type-registry.
60 DALI_TYPE_REGISTRATION_BEGIN(Scene3D::SceneView, Toolkit::Control, Create);
61 DALI_TYPE_REGISTRATION_END()
63 Property::Index RENDERING_BUFFER = Dali::Toolkit::Control::CONTROL_PROPERTY_END_INDEX + 1;
64 constexpr int32_t DEFAULT_ORIENTATION = 0;
66 constexpr uint8_t DEFAULT_FRAME_BUFFER_MULTI_SAMPLING_LEVEL = 4u;
68 static constexpr std::string_view SKYBOX_INTENSITY_STRING = "uIntensity";
70 Dali::Actor CreateSkybox(const std::string& skyboxUrl, Scene3D::SceneView::SkyboxType skyboxType)
77 Vertex skyboxVertices[] = {
79 {Vector3(-1.0f, 1.0f, -1.0f)},
80 {Vector3(-1.0f, -1.0f, -1.0f)},
81 {Vector3(1.0f, -1.0f, -1.0f)},
82 {Vector3(1.0f, -1.0f, -1.0f)},
83 {Vector3(1.0f, 1.0f, -1.0f)},
84 {Vector3(-1.0f, 1.0f, -1.0f)},
87 {Vector3(-1.0f, -1.0f, 1.0f)},
88 {Vector3(-1.0f, -1.0f, -1.0f)},
89 {Vector3(-1.0f, 1.0f, -1.0f)},
90 {Vector3(-1.0f, 1.0f, -1.0f)},
91 {Vector3(-1.0f, 1.0f, 1.0f)},
92 {Vector3(-1.0f, -1.0f, 1.0f)},
95 {Vector3(1.0f, -1.0f, -1.0f)},
96 {Vector3(1.0f, -1.0f, 1.0f)},
97 {Vector3(1.0f, 1.0f, 1.0f)},
98 {Vector3(1.0f, 1.0f, 1.0f)},
99 {Vector3(1.0f, 1.0f, -1.0f)},
100 {Vector3(1.0f, -1.0f, -1.0f)},
103 {Vector3(-1.0f, -1.0f, 1.0f)},
104 {Vector3(-1.0f, 1.0f, 1.0f)},
105 {Vector3(1.0f, 1.0f, 1.0f)},
106 {Vector3(1.0f, 1.0f, 1.0f)},
107 {Vector3(1.0f, -1.0f, 1.0f)},
108 {Vector3(-1.0f, -1.0f, 1.0f)},
111 {Vector3(-1.0f, 1.0f, -1.0f)},
112 {Vector3(1.0f, 1.0f, -1.0f)},
113 {Vector3(1.0f, 1.0f, 1.0f)},
114 {Vector3(1.0f, 1.0f, 1.0f)},
115 {Vector3(-1.0f, 1.0f, 1.0f)},
116 {Vector3(-1.0f, 1.0f, -1.0f)},
119 {Vector3(-1.0f, -1.0f, -1.0f)},
120 {Vector3(-1.0f, -1.0f, 1.0f)},
121 {Vector3(1.0f, -1.0f, -1.0f)},
122 {Vector3(1.0f, -1.0f, -1.0f)},
123 {Vector3(-1.0f, -1.0f, 1.0f)},
124 {Vector3(1.0f, -1.0f, 1.0f)}};
126 Dali::VertexBuffer vertexBuffer = Dali::VertexBuffer::New(Property::Map().Add("aPosition", Property::VECTOR3));
127 vertexBuffer.SetData(skyboxVertices, sizeof(skyboxVertices) / sizeof(Vertex));
129 Dali::Geometry skyboxGeometry = Geometry::New();
130 skyboxGeometry.AddVertexBuffer(vertexBuffer);
131 skyboxGeometry.SetType(Geometry::TRIANGLES);
133 Dali::Texture skyboxTexture;
134 Dali::Shader shaderSkybox;
135 Dali::Renderer skyboxRenderer;
137 if(skyboxType == Scene3D::SceneView::SkyboxType::CUBEMAP)
139 skyboxTexture = Dali::Scene3D::Loader::LoadCubeMap(skyboxUrl);
140 shaderSkybox = Shader::New(SHADER_SKYBOX_SHADER_VERT.data(), SHADER_SKYBOX_SHADER_FRAG.data());
142 else // Scene3D::SceneView::SkyboxType::EQUIRECTANGULAR
144 // Load image from file
145 PixelData pixels = Dali::Toolkit::SyncImageLoader::Load(skyboxUrl);
147 skyboxTexture = Texture::New(TextureType::TEXTURE_2D, pixels.GetPixelFormat(), pixels.GetWidth(), pixels.GetHeight());
148 skyboxTexture.Upload(pixels, 0, 0, 0, 0, pixels.GetWidth(), pixels.GetHeight());
149 shaderSkybox = Shader::New(SHADER_SKYBOX_SHADER_VERT.data(), SHADER_SKYBOX_EQUIRECTANGULAR_SHADER_FRAG.data());
152 Dali::TextureSet skyboxTextures = TextureSet::New();
153 skyboxTextures.SetTexture(0, skyboxTexture);
155 skyboxRenderer = Renderer::New(skyboxGeometry, shaderSkybox);
156 skyboxRenderer.SetTextures(skyboxTextures);
157 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_INDEX, 2.0f);
158 // Enables the depth test.
159 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_TEST_MODE, DepthTestMode::ON);
160 // The fragment shader will run only is those pixels that have the max depth value.
161 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_FUNCTION, DepthFunction::LESS_EQUAL);
163 Dali::Actor skyboxActor = Actor::New();
164 skyboxActor.SetProperty(Dali::Actor::Property::NAME, "SkyBox");
165 skyboxActor.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
166 skyboxActor.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
167 skyboxActor.AddRenderer(skyboxRenderer);
171 } // anonymous namespace
173 SceneView::SceneView()
174 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
175 mWindowOrientation(DEFAULT_ORIENTATION),
177 mSkyboxOrientation(Quaternion()),
178 mSkyboxIntensity(1.0f)
182 SceneView::~SceneView() = default;
184 Dali::Scene3D::SceneView SceneView::New()
186 SceneView* impl = new SceneView();
188 Dali::Scene3D::SceneView handle = Dali::Scene3D::SceneView(*impl);
190 // Second-phase init of the implementation
191 // This can only be done after the CustomActor connection has been made...
197 void SceneView::AddCamera(CameraActor camera)
203 UpdateCamera(camera);
205 mCameras.push_back(camera);
209 void SceneView::RemoveCamera(CameraActor camera)
211 if(camera == mDefaultCamera)
213 DALI_LOG_ERROR("Default Camera cannot removed.\n");
219 for(uint32_t i = 0; i < mCameras.size(); ++i)
221 if(mCameras[i] == camera)
223 mCameras.erase(mCameras.begin() + i);
228 if(mSelectedCamera == camera)
230 CameraActor newCurrentCamera = *mCameras.begin();
231 UpdateCamera(newCurrentCamera);
236 uint32_t SceneView::GetCameraCount() const
238 return mCameras.size();
241 CameraActor SceneView::GetSelectedCamera() const
243 return mSelectedCamera;
246 CameraActor SceneView::GetCamera(uint32_t index) const
248 if(index < mCameras.size())
250 return mCameras[index];
252 DALI_LOG_ERROR("Input index is out of bounds\n");
253 return CameraActor();
256 CameraActor SceneView::GetCamera(const std::string& name) const
258 CameraActor returnCamera;
259 for(auto&& camera : mCameras)
261 if(camera.GetProperty<std::string>(Actor::Property::NAME) == name)
263 returnCamera = camera;
270 void SceneView::SelectCamera(uint32_t index)
272 UpdateCamera(GetCamera(index));
275 void SceneView::SelectCamera(const std::string& name)
277 UpdateCamera(GetCamera(name));
280 void SceneView::RegisterSceneItem(Scene3D::Internal::ImageBasedLightObserver* item)
284 item->NotifyImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
285 mItems.push_back(item);
289 void SceneView::UnregisterSceneItem(Scene3D::Internal::ImageBasedLightObserver* item)
293 for(uint32_t i = 0; i < mItems.size(); ++i)
295 if(mItems[i] == item)
297 mItems.erase(mItems.begin() + i);
304 void SceneView::SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor)
306 mIBLResourceReady = false;
308 // If url is empty or invalid, reset IBL.
309 mDiffuseTexture = (!diffuseUrl.empty()) ? Dali::Scene3D::Loader::LoadCubeMap(diffuseUrl) : Texture();
310 mSpecularTexture = (!specularUrl.empty()) ? Dali::Scene3D::Loader::LoadCubeMap(specularUrl) : Texture();
312 mIblScaleFactor = scaleFactor;
314 for(auto&& item : mItems)
318 item->NotifyImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
322 mIBLResourceReady = true;
323 if(IsResourceReady())
325 Control::SetResourceReady(false);
329 void SceneView::SetImageBasedLightScaleFactor(float scaleFactor)
331 mIblScaleFactor = scaleFactor;
332 for(auto&& item : mItems)
336 item->NotifyImageBasedLightScaleFactor(scaleFactor);
341 float SceneView::GetImageBasedLightScaleFactor() const
343 return mIblScaleFactor;
346 void SceneView::UseFramebuffer(bool useFramebuffer)
348 if(mUseFrameBuffer != useFramebuffer)
350 mUseFrameBuffer = useFramebuffer;
355 bool SceneView::IsUsingFramebuffer() const
357 return mUseFrameBuffer;
360 void SceneView::SetSkybox(const std::string& skyboxUrl, Scene3D::SceneView::SkyboxType skyboxType)
362 mSkyboxResourceReady = false;
368 mSkybox = CreateSkybox(skyboxUrl, skyboxType);
369 SetSkyboxIntensity(mSkyboxIntensity);
370 SetSkyboxOrientation(mSkyboxOrientation);
373 mRootLayer.Add(mSkybox);
376 mSkyboxResourceReady = true;
377 if(IsResourceReady())
379 Control::SetResourceReady(false);
383 void SceneView::SetSkyboxIntensity(float intensity)
385 mSkyboxIntensity = intensity;
388 DALI_LOG_ERROR("Intensity should be greater than or equal to 0.\n");
389 mSkyboxIntensity = 0.0f;
394 mSkybox.RegisterProperty(SKYBOX_INTENSITY_STRING.data(), mSkyboxIntensity);
398 float SceneView::GetSkyboxIntensity() const
400 return mSkyboxIntensity;
403 void SceneView::SetSkyboxOrientation(const Quaternion& orientation)
405 mSkyboxOrientation = orientation;
408 mSkybox.SetProperty(Dali::Actor::Property::ORIENTATION, orientation);
412 Quaternion SceneView::GetSkyboxOrientation() const
414 return mSkyboxOrientation;
417 ///////////////////////////////////////////////////////////
422 void SceneView::OnSceneConnection(int depth)
424 Window window = DevelWindow::Get(Self());
427 window.ResizeSignal().Connect(this, &SceneView::OnWindowResized);
428 RenderTaskList taskList = window.GetRenderTaskList();
429 mRenderTask = taskList.CreateTask();
430 mRenderTask.SetSourceActor(mRootLayer);
431 mRenderTask.SetExclusive(true);
432 mRenderTask.SetInputEnabled(true);
433 mRenderTask.SetCullMode(false);
434 mRenderTask.SetScreenToFrameBufferMappingActor(Self());
440 Control::OnSceneConnection(depth);
443 void SceneView::OnSceneDisconnection()
447 Window window = mWindow.GetHandle();
450 window.ResizeSignal().Disconnect(this, &SceneView::OnWindowResized);
451 RenderTaskList taskList = window.GetRenderTaskList();
454 taskList.RemoveTask(mRenderTask);
455 mFrameBuffer.Reset();
460 Control::OnSceneDisconnection();
463 void SceneView::OnInitialize()
466 mRootLayer = Layer::New();
467 mRootLayer.SetProperty(Layer::Property::BEHAVIOR, Layer::LAYER_3D);
468 mRootLayer.SetProperty(Layer::Property::DEPTH_TEST, true);
469 // The models in the SceneView should be have independent coordinate with DALi default coordinate.
470 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_POSITION, false);
471 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_ORIENTATION, false);
472 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_SCALE, false);
473 self.Add(mRootLayer);
475 mDefaultCamera = Dali::CameraActor::New();
476 mDefaultCamera.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
477 mDefaultCamera.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
478 mDefaultCamera.SetNearClippingPlane(1.0f);
479 AddCamera(mDefaultCamera);
480 UpdateCamera(mDefaultCamera);
483 void SceneView::OnChildAdd(Actor& child)
485 if(child != mRootLayer)
487 mRootLayer.Add(child);
489 Control::OnChildAdd(child);
492 void SceneView::OnChildRemove(Actor& child)
494 mRootLayer.Remove(child);
495 Control::OnChildRemove(child);
498 float SceneView::GetHeightForWidth(float width)
501 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
502 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
505 float SceneView::GetWidthForHeight(float height)
508 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
509 return Control::GetWidthForHeight(height) + padding.start + padding.end;
512 void SceneView::OnRelayout(const Vector2& size, RelayoutContainer& container)
514 Control::OnRelayout(size, container);
515 // Change canvas size of camera actor.
519 bool SceneView::IsResourceReady() const
521 return mIBLResourceReady & mSkyboxResourceReady;
524 void SceneView::UpdateCamera(CameraActor camera)
528 if(mSelectedCamera && mSelectedCamera.GetParent())
530 mSelectedCamera.Unparent();
532 mRootLayer.Add(camera);
535 mSelectedCamera = camera;
539 void SceneView::UpdateRenderTask()
543 if(mSelectedCamera != mRenderTask.GetCameraActor())
545 mRenderTask.SetCameraActor(mSelectedCamera);
548 Vector3 size = Self().GetProperty<Vector3>(Dali::Actor::Property::SIZE);
549 const float aspectRatio = size.width / size.height;
550 mSelectedCamera.SetAspectRatio(aspectRatio);
554 Dali::FrameBuffer currentFrameBuffer = mRenderTask.GetFrameBuffer();
555 if(!currentFrameBuffer ||
556 !Dali::Equals(currentFrameBuffer.GetColorTexture().GetWidth(), size.width) ||
557 !Dali::Equals(currentFrameBuffer.GetColorTexture().GetHeight(), size.height))
559 mRootLayer.SetProperty(Dali::Actor::Property::COLOR_MODE, ColorMode::USE_OWN_COLOR);
560 mRenderTask.ResetViewportGuideActor();
561 mRenderTask.SetViewport(Dali::Viewport(Vector4::ZERO));
563 // create offscreen buffer of new size to render our child actors to
564 mTexture = Dali::Texture::New(TextureType::TEXTURE_2D, Pixel::RGBA8888, unsigned(size.width), unsigned(size.height));
565 mFrameBuffer = FrameBuffer::New(size.width, size.height, FrameBuffer::Attachment::DEPTH_STENCIL);
566 mFrameBuffer.AttachColorTexture(mTexture);
567 DevelFrameBuffer::SetMultiSamplingLevel(mFrameBuffer, DEFAULT_FRAME_BUFFER_MULTI_SAMPLING_LEVEL);
568 Dali::Toolkit::ImageUrl imageUrl = Dali::Toolkit::Image::GenerateUrl(mFrameBuffer, 0u);
570 Property::Map imagePropertyMap;
571 imagePropertyMap.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
572 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::URL, imageUrl.GetUrl());
573 // To make sure this visual call LoadTexture API immediate.
574 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, Toolkit::ImageVisual::LoadPolicy::IMMEDIATE);
575 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, Toolkit::ImageVisual::ReleasePolicy::DESTROYED);
576 // To flip rendered scene without CameraActor::SetInvertYAxis() to avoid backface culling.
577 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, Vector4(0.0f, 1.0f, 1.0f, -1.0f));
578 mVisual = Toolkit::VisualFactory::Get().CreateVisual(imagePropertyMap);
580 // Use premultiplied alpha when we use FBO
583 Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(true);
586 Toolkit::DevelControl::RegisterVisual(*this, RENDERING_BUFFER, mVisual);
588 mRenderTask.SetFrameBuffer(mFrameBuffer);
589 mRenderTask.SetClearEnabled(true);
590 mRenderTask.SetClearColor(Color::TRANSPARENT);
595 mRenderTask.SetViewportGuideActor(Self());
596 if(mRenderTask.GetFrameBuffer())
598 mRootLayer.SetProperty(Dali::Actor::Property::COLOR_MODE, ColorMode::USE_OWN_MULTIPLY_PARENT_ALPHA);
599 FrameBuffer framebuffer;
600 mRenderTask.SetFrameBuffer(framebuffer);
601 mRenderTask.SetClearEnabled(false);
603 Toolkit::DevelControl::UnregisterVisual(*this, RENDERING_BUFFER);
606 mFrameBuffer.Reset();
615 void SceneView::OnWindowResized(Window window, Window::WindowSize size)
617 mWindowOrientation = DevelWindow::GetPhysicalOrientation(window);
621 void SceneView::RotateCamera()
625 DevelCameraActor::RotateProjection(mSelectedCamera, DEFAULT_ORIENTATION);
629 DevelCameraActor::RotateProjection(mSelectedCamera, mWindowOrientation);
633 } // namespace Internal
634 } // namespace Scene3D