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/common/stage.h>
29 #include <dali/integration-api/debug.h>
30 #include <dali/public-api/object/type-registry-helper.h>
31 #include <dali/public-api/object/type-registry.h>
32 #include <dali/integration-api/adaptor-framework/adaptor.h>
35 #include <dali-scene3d/internal/controls/model/model-impl.h>
36 #include <dali-scene3d/public-api/loader/cube-map-loader.h>
38 #include <dali/integration-api/debug.h>
52 return Scene3D::SceneView::New();
55 // Setup properties, signals and actions using the type-registry.
56 DALI_TYPE_REGISTRATION_BEGIN(Scene3D::SceneView, Toolkit::Control, Create);
57 DALI_TYPE_REGISTRATION_END()
59 Property::Index RENDERING_BUFFER = Dali::Toolkit::Control::CONTROL_PROPERTY_END_INDEX + 1;
61 } // anonymous namespace
63 SceneView::SceneView()
64 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT)),
65 mIblLoadedCallback(nullptr)
69 SceneView::~SceneView()
71 if(mIblLoadedCallback && Adaptor::IsAvailable())
73 // Removes the callback from the callback manager in case the control is destroyed before the callback is executed.
74 Adaptor::Get().RemoveIdle(mIblLoadedCallback);
78 Dali::Scene3D::SceneView SceneView::New()
80 SceneView* impl = new SceneView();
82 Dali::Scene3D::SceneView handle = Dali::Scene3D::SceneView(*impl);
84 // Second-phase init of the implementation
85 // This can only be done after the CustomActor connection has been made...
91 void SceneView::AddCamera(CameraActor camera)
99 mCameras.push_back(camera);
103 void SceneView::RemoveCamera(CameraActor camera)
105 if(camera == mDefaultCamera)
107 DALI_LOG_ERROR("Default Camera cannot removed.\n");
113 for(uint32_t i = 0; i < mCameras.size(); ++i)
115 if(mCameras[i] == camera)
117 mCameras.erase(mCameras.begin() + i);
122 if(mSelectedCamera == camera)
124 CameraActor newCurrentCamera = *mCameras.begin();
125 UpdateCamera(newCurrentCamera);
130 uint32_t SceneView::GetCameraCount() const
132 return mCameras.size();
135 CameraActor SceneView::GetSelectedCamera() const
137 return mSelectedCamera;
140 CameraActor SceneView::GetCamera(uint32_t index) const
142 if(index < mCameras.size())
144 return mCameras[index];
146 DALI_LOG_ERROR("Input index is out of bounds\n");
147 return CameraActor();
150 CameraActor SceneView::GetCamera(const std::string& name) const
152 CameraActor returnCamera;
153 for(auto&& camera : mCameras)
155 if(camera.GetProperty<std::string>(Actor::Property::NAME) == name)
157 returnCamera = camera;
164 void SceneView::SelectCamera(uint32_t index)
166 UpdateCamera(GetCamera(index));
169 void SceneView::SelectCamera(const std::string& name)
171 UpdateCamera(GetCamera(name));
174 void SceneView::RegisterModel(Scene3D::Model model)
178 model.SetImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
179 mModels.push_back(model);
183 void SceneView::UnregisterModel(Scene3D::Model model)
187 for(uint32_t i = 0; i < mModels.size(); ++i)
189 if(mModels[i] == model)
191 mModels.erase(mModels.begin() + i);
198 void SceneView::SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor)
200 // Request asynchronous model loading
201 if(!mIblLoadedCallback)
203 mIBLResourceReady = false;
204 mDiffuseIblUrl = diffuseUrl;
205 mSpecularIblUrl = specularUrl;
206 mIblScaleFactor = scaleFactor;
207 // The callback manager takes the ownership of the callback object.
208 mIblLoadedCallback = MakeCallback(this, &SceneView::OnLoadComplete);
209 Adaptor::Get().AddIdle(mIblLoadedCallback, false);
213 void SceneView::SetImageBasedLightScaleFactor(float scaleFactor)
215 mIblScaleFactor = scaleFactor;
216 for(auto&& model : mModels)
220 model.SetImageBasedLightScaleFactor(scaleFactor);
225 float SceneView::GetImageBasedLightScaleFactor() const
227 return mIblScaleFactor;
230 void SceneView::UseFramebuffer(bool useFramebuffer)
232 if(mUseFrameBuffer != useFramebuffer)
234 mUseFrameBuffer = useFramebuffer;
239 bool SceneView::IsUsingFramebuffer() const
241 return mUseFrameBuffer;
244 ///////////////////////////////////////////////////////////
249 void SceneView::OnSceneConnection(int depth)
253 Control::OnSceneConnection(depth);
256 void SceneView::OnSceneDisconnection()
259 Control::OnSceneDisconnection();
262 void SceneView::OnInitialize()
265 mRootLayer = Layer::New();
266 mRootLayer.SetProperty(Layer::Property::BEHAVIOR, Layer::LAYER_3D);
267 mRootLayer.SetProperty(Layer::Property::DEPTH_TEST, true);
268 // The models in the SceneView should be have independent coordinate with DALi default coordinate.
269 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_POSITION, false);
270 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_ORIENTATION, false);
271 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_SCALE, false);
272 self.Add(mRootLayer);
274 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
275 mRenderTask = taskList.CreateTask();
276 mRenderTask.SetSourceActor(mRootLayer);
277 mRenderTask.SetExclusive(true);
278 mRenderTask.SetInputEnabled(true);
279 mRenderTask.SetCullMode(false);
280 mRenderTask.SetScreenToFrameBufferMappingActor(Self());
282 mDefaultCamera = Dali::CameraActor::New();
283 mDefaultCamera.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
284 mDefaultCamera.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
285 mDefaultCamera.SetNearClippingPlane(1.0f);
286 AddCamera(mDefaultCamera);
287 UpdateCamera(mDefaultCamera);
290 void SceneView::OnChildAdd(Actor& child)
292 if(child != mRootLayer)
294 mRootLayer.Add(child);
296 Control::OnChildAdd(child);
299 void SceneView::OnChildRemove(Actor& child)
301 mRootLayer.Remove(child);
302 Control::OnChildRemove(child);
305 float SceneView::GetHeightForWidth(float width)
308 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
309 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
312 float SceneView::GetWidthForHeight(float height)
315 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
316 return Control::GetWidthForHeight(height) + padding.start + padding.end;
319 void SceneView::OnRelayout(const Vector2& size, RelayoutContainer& container)
321 Control::OnRelayout(size, container);
322 // Change canvas size of camera actor.
326 bool SceneView::IsResourceReady() const
328 return mIBLResourceReady;
331 void SceneView::UpdateCamera(CameraActor camera)
335 if(mSelectedCamera && mSelectedCamera.GetParent())
337 mSelectedCamera.Unparent();
339 mRootLayer.Add(camera);
342 mSelectedCamera = camera;
346 void SceneView::UpdateRenderTask()
350 if(mSelectedCamera != mRenderTask.GetCameraActor())
352 mRenderTask.SetCameraActor(mSelectedCamera);
355 Vector3 size = Self().GetProperty<Vector3>(Dali::Actor::Property::SIZE);
356 const float aspectRatio = size.width / size.height;
357 mSelectedCamera.SetAspectRatio(aspectRatio);
358 const float halfHeight = mSelectedCamera[Dali::CameraActor::Property::TOP_PLANE_DISTANCE];
359 const float halfWidth = aspectRatio * halfHeight;
360 mSelectedCamera[Dali::CameraActor::Property::LEFT_PLANE_DISTANCE] = -halfWidth;
361 mSelectedCamera[Dali::CameraActor::Property::RIGHT_PLANE_DISTANCE] = halfWidth;
362 mSelectedCamera[Dali::CameraActor::Property::TOP_PLANE_DISTANCE] = halfHeight; // Top is +ve to keep consistency with orthographic values
363 mSelectedCamera[Dali::CameraActor::Property::BOTTOM_PLANE_DISTANCE] = -halfHeight; // Bottom is -ve to keep consistency with orthographic values
366 Dali::FrameBuffer currentFrameBuffer = mRenderTask.GetFrameBuffer();
367 if(!currentFrameBuffer ||
368 currentFrameBuffer.GetColorTexture().GetWidth() != size.width ||
369 currentFrameBuffer.GetColorTexture().GetHeight() != size.height)
371 mRenderTask.ResetViewportGuideActor();
372 mRenderTask.SetViewport(Dali::Viewport(Vector4::ZERO));
374 // create offscreen buffer of new size to render our child actors to
375 mTexture = Dali::Texture::New(TextureType::TEXTURE_2D, Pixel::RGBA8888, unsigned(size.width), unsigned(size.height));
376 mRenderTarget = FrameBuffer::New(size.width, size.height, FrameBuffer::Attachment::DEPTH_STENCIL);
377 mRenderTarget.AttachColorTexture(mTexture);
378 Dali::Toolkit::ImageUrl imageUrl = Dali::Toolkit::Image::GenerateUrl(mRenderTarget, 0u);
380 Property::Map imagePropertyMap;
381 imagePropertyMap.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
382 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::URL, imageUrl.GetUrl());
383 // To flip rendered scene without CameraActor::SetInvertYAxis() to avoid backface culling.
384 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, Vector4(0.0f, 1.0f, 1.0f, -1.0f));
385 mVisual = Toolkit::VisualFactory::Get().CreateVisual(imagePropertyMap);
387 Toolkit::DevelControl::RegisterVisual(*this, RENDERING_BUFFER, mVisual);
389 mRenderTask.SetFrameBuffer(mRenderTarget);
390 mRenderTask.SetClearEnabled(true);
391 mRenderTask.SetClearColor(Color::TRANSPARENT);
396 mRenderTask.SetViewportGuideActor(Self());
397 if(mRenderTask.GetFrameBuffer())
399 FrameBuffer framebuffer;
400 mRenderTask.SetFrameBuffer(framebuffer);
401 mRenderTask.SetClearEnabled(false);
403 Toolkit::DevelControl::UnregisterVisual(*this, RENDERING_BUFFER);
406 mRenderTarget.Reset();
413 void SceneView::LoadImageBasedLight()
415 Texture diffuseTexture = Dali::Scene3D::Loader::LoadCubeMap(mDiffuseIblUrl);
416 Texture specularTexture = Dali::Scene3D::Loader::LoadCubeMap(mSpecularIblUrl);
422 mDiffuseTexture = diffuseTexture;
423 mSpecularTexture = specularTexture;
425 for(auto&& model : mModels)
429 model.SetImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
436 void SceneView::OnLoadComplete()
438 // TODO: In this implementation, we cannot know which request occurs this OnLoadComplete Callback.
439 // Currently it is no problem because the all loading is processed in this method.
441 // Prevent to emit unnecessary resource ready signal.
442 if(IsResourceReady())
447 if(!mIBLResourceReady)
449 LoadImageBasedLight();
450 mIBLResourceReady = true;
451 mIblLoadedCallback = nullptr;
454 if(IsResourceReady())
456 Control::SetResourceReady(false);
460 } // namespace Internal
461 } // namespace Scene3D