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/devel-api/actors/camera-actor-devel.h>
29 #include <dali/devel-api/adaptor-framework/window-devel.h>
30 #include <dali/devel-api/common/stage.h>
31 #include <dali/devel-api/rendering/frame-buffer-devel.h>
32 #include <dali/integration-api/debug.h>
33 #include <dali/public-api/object/type-registry-helper.h>
34 #include <dali/public-api/object/type-registry.h>
35 #include <string_view>
38 #include <dali-scene3d/internal/controls/model/model-impl.h>
39 #include <dali-scene3d/internal/graphics/builtin-shader-extern-gen.h>
40 #include <dali-scene3d/public-api/loader/cube-map-loader.h>
54 return Scene3D::SceneView::New();
57 // Setup properties, signals and actions using the type-registry.
58 DALI_TYPE_REGISTRATION_BEGIN(Scene3D::SceneView, Toolkit::Control, Create);
59 DALI_TYPE_REGISTRATION_END()
61 Property::Index RENDERING_BUFFER = Dali::Toolkit::Control::CONTROL_PROPERTY_END_INDEX + 1;
62 constexpr int32_t DEFAULT_ORIENTATION = 0;
64 constexpr uint8_t DEFAULT_FRAME_BUFFER_MULTI_SAMPLING_LEVEL = 4u;
66 static constexpr std::string_view SKYBOX_INTENSITY_STRING = "uIntensity";
68 Dali::Actor CreateSkybox(const std::string& skyboxUrl)
75 Vertex skyboxVertices[] = {
77 {Vector3(-1.0f, 1.0f, -1.0f)},
78 {Vector3(-1.0f, -1.0f, -1.0f)},
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)},
85 {Vector3(-1.0f, -1.0f, 1.0f)},
86 {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)},
93 {Vector3(1.0f, -1.0f, -1.0f)},
94 {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)},
101 {Vector3(-1.0f, -1.0f, 1.0f)},
102 {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)},
109 {Vector3(-1.0f, 1.0f, -1.0f)},
110 {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)},
117 {Vector3(-1.0f, -1.0f, -1.0f)},
118 {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)}};
124 Dali::Shader shaderSkybox = Shader::New(SHADER_SKYBOX_SHADER_VERT.data(), SHADER_SKYBOX_SHADER_FRAG.data());
125 Dali::VertexBuffer vertexBuffer = Dali::VertexBuffer::New(Property::Map().Add("aPosition", Property::VECTOR3));
126 vertexBuffer.SetData(skyboxVertices, sizeof(skyboxVertices) / sizeof(Vertex));
128 Dali::Geometry skyboxGeometry = Geometry::New();
129 skyboxGeometry.AddVertexBuffer(vertexBuffer);
130 skyboxGeometry.SetType(Geometry::TRIANGLES);
132 Dali::Texture skyboxTexture = Dali::Scene3D::Loader::LoadCubeMap(skyboxUrl);
133 Dali::TextureSet skyboxTextures = TextureSet::New();
134 skyboxTextures.SetTexture(0, skyboxTexture);
136 Dali::Renderer skyboxRenderer = Renderer::New(skyboxGeometry, shaderSkybox);
137 skyboxRenderer.SetTextures(skyboxTextures);
138 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_INDEX, 2.0f);
139 // Enables the depth test.
140 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_TEST_MODE, DepthTestMode::ON);
141 // The fragment shader will run only is those pixels that have the max depth value.
142 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_FUNCTION, DepthFunction::LESS_EQUAL);
144 Dali::Actor skyboxActor = Actor::New();
145 skyboxActor.SetProperty(Dali::Actor::Property::NAME, "SkyBox");
146 skyboxActor.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
147 skyboxActor.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
148 skyboxActor.AddRenderer(skyboxRenderer);
152 } // anonymous namespace
154 SceneView::SceneView()
155 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
156 mWindowOrientation(DEFAULT_ORIENTATION),
158 mSkyboxOrientation(Quaternion()),
159 mSkyboxIntensity(1.0f)
163 SceneView::~SceneView() = default;
165 Dali::Scene3D::SceneView SceneView::New()
167 SceneView* impl = new SceneView();
169 Dali::Scene3D::SceneView handle = Dali::Scene3D::SceneView(*impl);
171 // Second-phase init of the implementation
172 // This can only be done after the CustomActor connection has been made...
178 void SceneView::AddCamera(CameraActor camera)
184 UpdateCamera(camera);
186 mCameras.push_back(camera);
190 void SceneView::RemoveCamera(CameraActor camera)
192 if(camera == mDefaultCamera)
194 DALI_LOG_ERROR("Default Camera cannot removed.\n");
200 for(uint32_t i = 0; i < mCameras.size(); ++i)
202 if(mCameras[i] == camera)
204 mCameras.erase(mCameras.begin() + i);
209 if(mSelectedCamera == camera)
211 CameraActor newCurrentCamera = *mCameras.begin();
212 UpdateCamera(newCurrentCamera);
217 uint32_t SceneView::GetCameraCount() const
219 return mCameras.size();
222 CameraActor SceneView::GetSelectedCamera() const
224 return mSelectedCamera;
227 CameraActor SceneView::GetCamera(uint32_t index) const
229 if(index < mCameras.size())
231 return mCameras[index];
233 DALI_LOG_ERROR("Input index is out of bounds\n");
234 return CameraActor();
237 CameraActor SceneView::GetCamera(const std::string& name) const
239 CameraActor returnCamera;
240 for(auto&& camera : mCameras)
242 if(camera.GetProperty<std::string>(Actor::Property::NAME) == name)
244 returnCamera = camera;
251 void SceneView::SelectCamera(uint32_t index)
253 UpdateCamera(GetCamera(index));
256 void SceneView::SelectCamera(const std::string& name)
258 UpdateCamera(GetCamera(name));
261 void SceneView::RegisterSceneItem(Scene3D::Internal::ImageBasedLightObserver* item)
265 item->NotifyImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
266 mItems.push_back(item);
270 void SceneView::UnregisterSceneItem(Scene3D::Internal::ImageBasedLightObserver* item)
274 for(uint32_t i = 0; i < mItems.size(); ++i)
276 if(mItems[i] == item)
278 mItems.erase(mItems.begin() + i);
285 void SceneView::SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor)
287 mIBLResourceReady = false;
289 // If url is empty or invalid, reset IBL.
290 mDiffuseTexture = (!diffuseUrl.empty()) ? Dali::Scene3D::Loader::LoadCubeMap(diffuseUrl) : Texture();
291 mSpecularTexture = (!specularUrl.empty()) ? Dali::Scene3D::Loader::LoadCubeMap(specularUrl) : Texture();
293 mIblScaleFactor = scaleFactor;
295 for(auto&& item : mItems)
299 item->NotifyImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
303 mIBLResourceReady = true;
304 if(IsResourceReady())
306 Control::SetResourceReady(false);
310 void SceneView::SetImageBasedLightScaleFactor(float scaleFactor)
312 mIblScaleFactor = scaleFactor;
313 for(auto&& item : mItems)
317 item->NotifyImageBasedLightScaleFactor(scaleFactor);
322 float SceneView::GetImageBasedLightScaleFactor() const
324 return mIblScaleFactor;
327 void SceneView::UseFramebuffer(bool useFramebuffer)
329 if(mUseFrameBuffer != useFramebuffer)
331 mUseFrameBuffer = useFramebuffer;
336 bool SceneView::IsUsingFramebuffer() const
338 return mUseFrameBuffer;
341 void SceneView::SetSkybox(const std::string& skyboxUrl)
343 mSkyboxResourceReady = false;
349 mSkybox = CreateSkybox(skyboxUrl);
350 SetSkyboxIntensity(mSkyboxIntensity);
351 SetSkyboxOrientation(mSkyboxOrientation);
354 mRootLayer.Add(mSkybox);
357 mSkyboxResourceReady = true;
358 if(IsResourceReady())
360 Control::SetResourceReady(false);
364 void SceneView::SetSkyboxIntensity(float intensity)
366 mSkyboxIntensity = intensity;
369 DALI_LOG_ERROR("Intensity should be greater than or equal to 0.\n");
370 mSkyboxIntensity = 0.0f;
375 mSkybox.RegisterProperty(SKYBOX_INTENSITY_STRING.data(), mSkyboxIntensity);
379 float SceneView::GetSkyboxIntensity() const
381 return mSkyboxIntensity;
384 void SceneView::SetSkyboxOrientation(const Quaternion& orientation)
386 mSkyboxOrientation = orientation;
389 mSkybox.SetProperty(Dali::Actor::Property::ORIENTATION, orientation);
393 Quaternion SceneView::GetSkyboxOrientation() const
395 return mSkyboxOrientation;
398 ///////////////////////////////////////////////////////////
403 void SceneView::OnSceneConnection(int depth)
405 Window window = DevelWindow::Get(Self());
408 window.ResizeSignal().Connect(this, &SceneView::OnWindowResized);
409 RenderTaskList taskList = window.GetRenderTaskList();
410 mRenderTask = taskList.CreateTask();
411 mRenderTask.SetSourceActor(mRootLayer);
412 mRenderTask.SetExclusive(true);
413 mRenderTask.SetInputEnabled(true);
414 mRenderTask.SetCullMode(false);
415 mRenderTask.SetScreenToFrameBufferMappingActor(Self());
421 Control::OnSceneConnection(depth);
424 void SceneView::OnSceneDisconnection()
428 Window window = mWindow.GetHandle();
431 window.ResizeSignal().Disconnect(this, &SceneView::OnWindowResized);
432 RenderTaskList taskList = window.GetRenderTaskList();
435 taskList.RemoveTask(mRenderTask);
436 mFrameBuffer.Reset();
441 Control::OnSceneDisconnection();
444 void SceneView::OnInitialize()
447 mRootLayer = Layer::New();
448 mRootLayer.SetProperty(Layer::Property::BEHAVIOR, Layer::LAYER_3D);
449 mRootLayer.SetProperty(Layer::Property::DEPTH_TEST, true);
450 // The models in the SceneView should be have independent coordinate with DALi default coordinate.
451 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_POSITION, false);
452 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_ORIENTATION, false);
453 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_SCALE, false);
454 self.Add(mRootLayer);
456 mDefaultCamera = Dali::CameraActor::New();
457 mDefaultCamera.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
458 mDefaultCamera.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
459 mDefaultCamera.SetNearClippingPlane(1.0f);
460 AddCamera(mDefaultCamera);
461 UpdateCamera(mDefaultCamera);
464 void SceneView::OnChildAdd(Actor& child)
466 if(child != mRootLayer)
468 mRootLayer.Add(child);
470 Control::OnChildAdd(child);
473 void SceneView::OnChildRemove(Actor& child)
475 mRootLayer.Remove(child);
476 Control::OnChildRemove(child);
479 float SceneView::GetHeightForWidth(float width)
482 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
483 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
486 float SceneView::GetWidthForHeight(float height)
489 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
490 return Control::GetWidthForHeight(height) + padding.start + padding.end;
493 void SceneView::OnRelayout(const Vector2& size, RelayoutContainer& container)
495 Control::OnRelayout(size, container);
496 // Change canvas size of camera actor.
500 bool SceneView::IsResourceReady() const
502 return mIBLResourceReady & mSkyboxResourceReady;
505 void SceneView::UpdateCamera(CameraActor camera)
509 if(mSelectedCamera && mSelectedCamera.GetParent())
511 mSelectedCamera.Unparent();
513 mRootLayer.Add(camera);
516 mSelectedCamera = camera;
520 void SceneView::UpdateRenderTask()
524 if(mSelectedCamera != mRenderTask.GetCameraActor())
526 mRenderTask.SetCameraActor(mSelectedCamera);
529 Vector3 size = Self().GetProperty<Vector3>(Dali::Actor::Property::SIZE);
530 const float aspectRatio = size.width / size.height;
531 mSelectedCamera.SetAspectRatio(aspectRatio);
535 Dali::FrameBuffer currentFrameBuffer = mRenderTask.GetFrameBuffer();
536 if(!currentFrameBuffer ||
537 currentFrameBuffer.GetColorTexture().GetWidth() != size.width ||
538 currentFrameBuffer.GetColorTexture().GetHeight() != size.height)
540 mRenderTask.ResetViewportGuideActor();
541 mRenderTask.SetViewport(Dali::Viewport(Vector4::ZERO));
543 // create offscreen buffer of new size to render our child actors to
544 mTexture = Dali::Texture::New(TextureType::TEXTURE_2D, Pixel::RGBA8888, unsigned(size.width), unsigned(size.height));
545 mFrameBuffer = FrameBuffer::New(size.width, size.height, FrameBuffer::Attachment::DEPTH_STENCIL);
546 mFrameBuffer.AttachColorTexture(mTexture);
547 DevelFrameBuffer::SetMultiSamplingLevel(mFrameBuffer, DEFAULT_FRAME_BUFFER_MULTI_SAMPLING_LEVEL);
548 Dali::Toolkit::ImageUrl imageUrl = Dali::Toolkit::Image::GenerateUrl(mFrameBuffer, 0u);
550 Property::Map imagePropertyMap;
551 imagePropertyMap.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
552 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::URL, imageUrl.GetUrl());
553 // To make sure this visual call LoadTexture API immediate.
554 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, Toolkit::ImageVisual::LoadPolicy::IMMEDIATE);
555 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, Toolkit::ImageVisual::ReleasePolicy::DESTROYED);
556 // To flip rendered scene without CameraActor::SetInvertYAxis() to avoid backface culling.
557 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, Vector4(0.0f, 1.0f, 1.0f, -1.0f));
558 mVisual = Toolkit::VisualFactory::Get().CreateVisual(imagePropertyMap);
560 // Use premultiplied alpha when we use FBO
563 Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(true);
566 Toolkit::DevelControl::RegisterVisual(*this, RENDERING_BUFFER, mVisual);
568 mRenderTask.SetFrameBuffer(mFrameBuffer);
569 mRenderTask.SetClearEnabled(true);
570 mRenderTask.SetClearColor(Color::TRANSPARENT);
575 mRenderTask.SetViewportGuideActor(Self());
576 if(mRenderTask.GetFrameBuffer())
578 FrameBuffer framebuffer;
579 mRenderTask.SetFrameBuffer(framebuffer);
580 mRenderTask.SetClearEnabled(false);
582 Toolkit::DevelControl::UnregisterVisual(*this, RENDERING_BUFFER);
585 mFrameBuffer.Reset();
594 void SceneView::OnWindowResized(Window window, Window::WindowSize size)
596 mWindowOrientation = DevelWindow::GetPhysicalOrientation(window);
600 void SceneView::RotateCamera()
604 DevelCameraActor::RotateProjection(mSelectedCamera, DEFAULT_ORIENTATION);
608 DevelCameraActor::RotateProjection(mSelectedCamera, mWindowOrientation);
612 } // namespace Internal
613 } // namespace Scene3D