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/object/type-registry-helper.h>
35 #include <dali/public-api/object/type-registry.h>
36 #include <string_view>
39 #include <dali-scene3d/internal/controls/model/model-impl.h>
40 #include <dali-scene3d/internal/graphics/builtin-shader-extern-gen.h>
41 #include <dali-scene3d/public-api/loader/cube-map-loader.h>
55 return Scene3D::SceneView::New();
58 // Setup properties, signals and actions using the type-registry.
59 DALI_TYPE_REGISTRATION_BEGIN(Scene3D::SceneView, Toolkit::Control, Create);
60 DALI_TYPE_REGISTRATION_END()
62 Property::Index RENDERING_BUFFER = Dali::Toolkit::Control::CONTROL_PROPERTY_END_INDEX + 1;
63 constexpr int32_t DEFAULT_ORIENTATION = 0;
65 constexpr uint8_t DEFAULT_FRAME_BUFFER_MULTI_SAMPLING_LEVEL = 4u;
67 static constexpr std::string_view SKYBOX_INTENSITY_STRING = "uIntensity";
69 Dali::Actor CreateSkybox(const std::string& skyboxUrl, Scene3D::SceneView::SkyboxType skyboxType)
76 Vertex skyboxVertices[] = {
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)},
83 {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)},
91 {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)},
99 {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)},
107 {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)},
115 {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)},
123 {Vector3(1.0f, -1.0f, 1.0f)}};
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;
133 Dali::Shader shaderSkybox;
134 Dali::Renderer skyboxRenderer;
136 if(skyboxType == Scene3D::SceneView::SkyboxType::CUBEMAP)
138 skyboxTexture = Dali::Scene3D::Loader::LoadCubeMap(skyboxUrl);
139 shaderSkybox = Shader::New(SHADER_SKYBOX_SHADER_VERT.data(), SHADER_SKYBOX_SHADER_FRAG.data());
141 else // Scene3D::SceneView::SkyboxType::EQUIRECTANGULAR
143 // Load image from file
144 PixelData pixels = Dali::Toolkit::SyncImageLoader::Load(skyboxUrl);
146 skyboxTexture = Texture::New(TextureType::TEXTURE_2D, pixels.GetPixelFormat(), pixels.GetWidth(), pixels.GetHeight());
147 skyboxTexture.Upload(pixels, 0, 0, 0, 0, pixels.GetWidth(), pixels.GetHeight());
148 shaderSkybox = Shader::New(SHADER_SKYBOX_SHADER_VERT.data(), SHADER_SKYBOX_EQUIRECTANGULAR_SHADER_FRAG.data());
151 Dali::TextureSet skyboxTextures = TextureSet::New();
152 skyboxTextures.SetTexture(0, skyboxTexture);
154 skyboxRenderer = Renderer::New(skyboxGeometry, shaderSkybox);
155 skyboxRenderer.SetTextures(skyboxTextures);
156 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_INDEX, 2.0f);
157 // Enables the depth test.
158 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_TEST_MODE, DepthTestMode::ON);
159 // The fragment shader will run only is those pixels that have the max depth value.
160 skyboxRenderer.SetProperty(Renderer::Property::DEPTH_FUNCTION, DepthFunction::LESS_EQUAL);
162 Dali::Actor skyboxActor = Actor::New();
163 skyboxActor.SetProperty(Dali::Actor::Property::NAME, "SkyBox");
164 skyboxActor.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
165 skyboxActor.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
166 skyboxActor.AddRenderer(skyboxRenderer);
170 } // anonymous namespace
172 SceneView::SceneView()
173 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
174 mWindowOrientation(DEFAULT_ORIENTATION),
176 mSkyboxOrientation(Quaternion()),
177 mSkyboxIntensity(1.0f)
181 SceneView::~SceneView() = default;
183 Dali::Scene3D::SceneView SceneView::New()
185 SceneView* impl = new SceneView();
187 Dali::Scene3D::SceneView handle = Dali::Scene3D::SceneView(*impl);
189 // Second-phase init of the implementation
190 // This can only be done after the CustomActor connection has been made...
196 void SceneView::AddCamera(CameraActor camera)
202 UpdateCamera(camera);
204 mCameras.push_back(camera);
208 void SceneView::RemoveCamera(CameraActor camera)
210 if(camera == mDefaultCamera)
212 DALI_LOG_ERROR("Default Camera cannot removed.\n");
218 for(uint32_t i = 0; i < mCameras.size(); ++i)
220 if(mCameras[i] == camera)
222 mCameras.erase(mCameras.begin() + i);
227 if(mSelectedCamera == camera)
229 CameraActor newCurrentCamera = *mCameras.begin();
230 UpdateCamera(newCurrentCamera);
235 uint32_t SceneView::GetCameraCount() const
237 return mCameras.size();
240 CameraActor SceneView::GetSelectedCamera() const
242 return mSelectedCamera;
245 CameraActor SceneView::GetCamera(uint32_t index) const
247 if(index < mCameras.size())
249 return mCameras[index];
251 DALI_LOG_ERROR("Input index is out of bounds\n");
252 return CameraActor();
255 CameraActor SceneView::GetCamera(const std::string& name) const
257 CameraActor returnCamera;
258 for(auto&& camera : mCameras)
260 if(camera.GetProperty<std::string>(Actor::Property::NAME) == name)
262 returnCamera = camera;
269 void SceneView::SelectCamera(uint32_t index)
271 UpdateCamera(GetCamera(index));
274 void SceneView::SelectCamera(const std::string& name)
276 UpdateCamera(GetCamera(name));
279 void SceneView::RegisterSceneItem(Scene3D::Internal::ImageBasedLightObserver* item)
283 item->NotifyImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
284 mItems.push_back(item);
288 void SceneView::UnregisterSceneItem(Scene3D::Internal::ImageBasedLightObserver* item)
292 for(uint32_t i = 0; i < mItems.size(); ++i)
294 if(mItems[i] == item)
296 mItems.erase(mItems.begin() + i);
303 void SceneView::SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor)
305 mIBLResourceReady = false;
307 // If url is empty or invalid, reset IBL.
308 mDiffuseTexture = (!diffuseUrl.empty()) ? Dali::Scene3D::Loader::LoadCubeMap(diffuseUrl) : Texture();
309 mSpecularTexture = (!specularUrl.empty()) ? Dali::Scene3D::Loader::LoadCubeMap(specularUrl) : Texture();
311 mIblScaleFactor = scaleFactor;
313 for(auto&& item : mItems)
317 item->NotifyImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
321 mIBLResourceReady = true;
322 if(IsResourceReady())
324 Control::SetResourceReady(false);
328 void SceneView::SetImageBasedLightScaleFactor(float scaleFactor)
330 mIblScaleFactor = scaleFactor;
331 for(auto&& item : mItems)
335 item->NotifyImageBasedLightScaleFactor(scaleFactor);
340 float SceneView::GetImageBasedLightScaleFactor() const
342 return mIblScaleFactor;
345 void SceneView::UseFramebuffer(bool useFramebuffer)
347 if(mUseFrameBuffer != useFramebuffer)
349 mUseFrameBuffer = useFramebuffer;
354 bool SceneView::IsUsingFramebuffer() const
356 return mUseFrameBuffer;
359 void SceneView::SetSkybox(const std::string& skyboxUrl, Scene3D::SceneView::SkyboxType skyboxType)
361 mSkyboxResourceReady = false;
367 mSkybox = CreateSkybox(skyboxUrl, skyboxType);
368 SetSkyboxIntensity(mSkyboxIntensity);
369 SetSkyboxOrientation(mSkyboxOrientation);
372 mRootLayer.Add(mSkybox);
375 mSkyboxResourceReady = true;
376 if(IsResourceReady())
378 Control::SetResourceReady(false);
382 void SceneView::SetSkyboxIntensity(float intensity)
384 mSkyboxIntensity = intensity;
387 DALI_LOG_ERROR("Intensity should be greater than or equal to 0.\n");
388 mSkyboxIntensity = 0.0f;
393 mSkybox.RegisterProperty(SKYBOX_INTENSITY_STRING.data(), mSkyboxIntensity);
397 float SceneView::GetSkyboxIntensity() const
399 return mSkyboxIntensity;
402 void SceneView::SetSkyboxOrientation(const Quaternion& orientation)
404 mSkyboxOrientation = orientation;
407 mSkybox.SetProperty(Dali::Actor::Property::ORIENTATION, orientation);
411 Quaternion SceneView::GetSkyboxOrientation() const
413 return mSkyboxOrientation;
416 ///////////////////////////////////////////////////////////
421 void SceneView::OnSceneConnection(int depth)
423 Window window = DevelWindow::Get(Self());
426 window.ResizeSignal().Connect(this, &SceneView::OnWindowResized);
427 RenderTaskList taskList = window.GetRenderTaskList();
428 mRenderTask = taskList.CreateTask();
429 mRenderTask.SetSourceActor(mRootLayer);
430 mRenderTask.SetExclusive(true);
431 mRenderTask.SetInputEnabled(true);
432 mRenderTask.SetCullMode(false);
433 mRenderTask.SetScreenToFrameBufferMappingActor(Self());
439 Control::OnSceneConnection(depth);
442 void SceneView::OnSceneDisconnection()
446 Window window = mWindow.GetHandle();
449 window.ResizeSignal().Disconnect(this, &SceneView::OnWindowResized);
450 RenderTaskList taskList = window.GetRenderTaskList();
453 taskList.RemoveTask(mRenderTask);
454 mFrameBuffer.Reset();
459 Control::OnSceneDisconnection();
462 void SceneView::OnInitialize()
465 mRootLayer = Layer::New();
466 mRootLayer.SetProperty(Layer::Property::BEHAVIOR, Layer::LAYER_3D);
467 mRootLayer.SetProperty(Layer::Property::DEPTH_TEST, true);
468 // The models in the SceneView should be have independent coordinate with DALi default coordinate.
469 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_POSITION, false);
470 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_ORIENTATION, false);
471 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_SCALE, false);
472 self.Add(mRootLayer);
474 mDefaultCamera = Dali::CameraActor::New();
475 mDefaultCamera.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
476 mDefaultCamera.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
477 mDefaultCamera.SetNearClippingPlane(1.0f);
478 AddCamera(mDefaultCamera);
479 UpdateCamera(mDefaultCamera);
482 void SceneView::OnChildAdd(Actor& child)
484 if(child != mRootLayer)
486 mRootLayer.Add(child);
488 Control::OnChildAdd(child);
491 void SceneView::OnChildRemove(Actor& child)
493 mRootLayer.Remove(child);
494 Control::OnChildRemove(child);
497 float SceneView::GetHeightForWidth(float width)
500 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
501 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
504 float SceneView::GetWidthForHeight(float height)
507 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
508 return Control::GetWidthForHeight(height) + padding.start + padding.end;
511 void SceneView::OnRelayout(const Vector2& size, RelayoutContainer& container)
513 Control::OnRelayout(size, container);
514 // Change canvas size of camera actor.
518 bool SceneView::IsResourceReady() const
520 return mIBLResourceReady & mSkyboxResourceReady;
523 void SceneView::UpdateCamera(CameraActor camera)
527 if(mSelectedCamera && mSelectedCamera.GetParent())
529 mSelectedCamera.Unparent();
531 mRootLayer.Add(camera);
534 mSelectedCamera = camera;
538 void SceneView::UpdateRenderTask()
542 if(mSelectedCamera != mRenderTask.GetCameraActor())
544 mRenderTask.SetCameraActor(mSelectedCamera);
547 Vector3 size = Self().GetProperty<Vector3>(Dali::Actor::Property::SIZE);
548 const float aspectRatio = size.width / size.height;
549 mSelectedCamera.SetAspectRatio(aspectRatio);
553 Dali::FrameBuffer currentFrameBuffer = mRenderTask.GetFrameBuffer();
554 if(!currentFrameBuffer ||
555 currentFrameBuffer.GetColorTexture().GetWidth() != size.width ||
556 currentFrameBuffer.GetColorTexture().GetHeight() != size.height)
558 mRenderTask.ResetViewportGuideActor();
559 mRenderTask.SetViewport(Dali::Viewport(Vector4::ZERO));
561 // create offscreen buffer of new size to render our child actors to
562 mTexture = Dali::Texture::New(TextureType::TEXTURE_2D, Pixel::RGBA8888, unsigned(size.width), unsigned(size.height));
563 mFrameBuffer = FrameBuffer::New(size.width, size.height, FrameBuffer::Attachment::DEPTH_STENCIL);
564 mFrameBuffer.AttachColorTexture(mTexture);
565 DevelFrameBuffer::SetMultiSamplingLevel(mFrameBuffer, DEFAULT_FRAME_BUFFER_MULTI_SAMPLING_LEVEL);
566 Dali::Toolkit::ImageUrl imageUrl = Dali::Toolkit::Image::GenerateUrl(mFrameBuffer, 0u);
568 Property::Map imagePropertyMap;
569 imagePropertyMap.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
570 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::URL, imageUrl.GetUrl());
571 // To make sure this visual call LoadTexture API immediate.
572 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, Toolkit::ImageVisual::LoadPolicy::IMMEDIATE);
573 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, Toolkit::ImageVisual::ReleasePolicy::DESTROYED);
574 // To flip rendered scene without CameraActor::SetInvertYAxis() to avoid backface culling.
575 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, Vector4(0.0f, 1.0f, 1.0f, -1.0f));
576 mVisual = Toolkit::VisualFactory::Get().CreateVisual(imagePropertyMap);
578 // Use premultiplied alpha when we use FBO
581 Toolkit::GetImplementation(mVisual).EnablePreMultipliedAlpha(true);
584 Toolkit::DevelControl::RegisterVisual(*this, RENDERING_BUFFER, mVisual);
586 mRenderTask.SetFrameBuffer(mFrameBuffer);
587 mRenderTask.SetClearEnabled(true);
588 mRenderTask.SetClearColor(Color::TRANSPARENT);
593 mRenderTask.SetViewportGuideActor(Self());
594 if(mRenderTask.GetFrameBuffer())
596 FrameBuffer framebuffer;
597 mRenderTask.SetFrameBuffer(framebuffer);
598 mRenderTask.SetClearEnabled(false);
600 Toolkit::DevelControl::UnregisterVisual(*this, RENDERING_BUFFER);
603 mFrameBuffer.Reset();
612 void SceneView::OnWindowResized(Window window, Window::WindowSize size)
614 mWindowOrientation = DevelWindow::GetPhysicalOrientation(window);
618 void SceneView::RotateCamera()
622 DevelCameraActor::RotateProjection(mSelectedCamera, DEFAULT_ORIENTATION);
626 DevelCameraActor::RotateProjection(mSelectedCamera, mWindowOrientation);
630 } // namespace Internal
631 } // namespace Scene3D