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>
34 #include <dali-scene3d/internal/controls/model-view/model-view-impl.h>
35 #include <dali-scene3d/public-api/loader/cube-map-loader.h>
37 #include <dali/integration-api/debug.h>
51 return Scene3D::SceneView::New();
54 // Setup properties, signals and actions using the type-registry.
55 DALI_TYPE_REGISTRATION_BEGIN(Scene3D::SceneView, Toolkit::Control, Create);
56 DALI_TYPE_REGISTRATION_END()
58 Property::Index RENDERING_BUFFER = Dali::Toolkit::Control::CONTROL_PROPERTY_END_INDEX + 1;
60 } // anonymous namespace
62 SceneView::SceneView()
63 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT))
67 SceneView::~SceneView() = default;
69 Dali::Scene3D::SceneView SceneView::New()
71 SceneView* impl = new SceneView();
73 Dali::Scene3D::SceneView handle = Dali::Scene3D::SceneView(*impl);
75 // Second-phase init of the implementation
76 // This can only be done after the CustomActor connection has been made...
82 void SceneView::AddCamera(CameraActor camera)
90 mCameras.push_back(camera);
94 void SceneView::RemoveCamera(CameraActor camera)
96 if(camera == mDefaultCamera)
98 DALI_LOG_ERROR("Default Camera cannot removed.\n");
104 for(uint32_t i = 0; i < mCameras.size(); ++i)
106 if(mCameras[i] == camera)
108 mCameras.erase(mCameras.begin() + i);
113 if(mSelectedCamera == camera)
115 CameraActor newCurrentCamera = *mCameras.begin();
116 UpdateCamera(newCurrentCamera);
121 uint32_t SceneView::GetCameraCount() const
123 return mCameras.size();
126 CameraActor SceneView::GetSelectedCamera() const
128 return mSelectedCamera;
131 CameraActor SceneView::GetCamera(uint32_t index) const
133 if(index < mCameras.size())
135 return mCameras[index];
137 DALI_LOG_ERROR("Input index is out of bounds\n");
138 return CameraActor();
141 CameraActor SceneView::GetCamera(const std::string& name) const
143 CameraActor returnCamera;
144 for(auto&& camera : mCameras)
146 if(camera.GetProperty<std::string>(Actor::Property::NAME) == name)
148 returnCamera = camera;
155 void SceneView::SelectCamera(uint32_t index)
157 UpdateCamera(GetCamera(index));
160 void SceneView::SelectCamera(const std::string& name)
162 UpdateCamera(GetCamera(name));
165 void SceneView::RegisterModelView(Scene3D::ModelView modelView)
169 modelView.SetImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
170 mModels.push_back(modelView);
174 void SceneView::UnregisterModelView(Scene3D::ModelView modelView)
178 for(uint32_t i = 0; i < mModels.size(); ++i)
180 if(mModels[i] == modelView)
182 mModels.erase(mModels.begin() + i);
189 void SceneView::SetImageBasedLightSource(const std::string& diffuse, const std::string& specular, float scaleFactor)
191 mIBLResourceReady = false;
192 Texture diffuseTexture = Dali::Scene3D::Loader::LoadCubeMap(diffuse);
195 Texture specularTexture = Dali::Scene3D::Loader::LoadCubeMap(specular);
198 mDiffuseTexture = diffuseTexture;
199 mSpecularTexture = specularTexture;
200 mIblScaleFactor = scaleFactor;
202 for(auto&& model : mModels)
206 model.SetImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
211 mIBLResourceReady = true;
212 Control::SetResourceReady(false);
215 void SceneView::SetImageBasedLightScaleFactor(float scaleFactor)
217 mIblScaleFactor = scaleFactor;
218 for(auto&& model : mModels)
222 model.SetImageBasedLightScaleFactor(scaleFactor);
227 float SceneView::GetImageBasedLightScaleFactor() const
229 return mIblScaleFactor;
232 void SceneView::UseFramebuffer(bool useFramebuffer)
234 if(mUseFrameBuffer != useFramebuffer)
236 mUseFrameBuffer = useFramebuffer;
241 bool SceneView::IsUsingFramebuffer() const
243 return mUseFrameBuffer;
246 ///////////////////////////////////////////////////////////
251 void SceneView::OnSceneConnection(int depth)
255 Control::OnSceneConnection(depth);
258 void SceneView::OnSceneDisconnection()
261 Control::OnSceneDisconnection();
264 void SceneView::OnInitialize()
267 mRootLayer = Layer::New();
268 mRootLayer.SetProperty(Layer::Property::BEHAVIOR, Layer::LAYER_3D);
269 mRootLayer.SetProperty(Layer::Property::DEPTH_TEST, true);
270 // The models in the SceneView should be have independent coordinate with DALi default coordinate.
271 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_POSITION, false);
272 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_ORIENTATION, false);
273 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_SCALE, false);
274 self.Add(mRootLayer);
276 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
277 mRenderTask = taskList.CreateTask();
278 mRenderTask.SetSourceActor(mRootLayer);
279 mRenderTask.SetExclusive(true);
280 mRenderTask.SetInputEnabled(true);
281 mRenderTask.SetCullMode(false);
282 mRenderTask.SetScreenToFrameBufferMappingActor(Self());
284 mDefaultCamera = Dali::CameraActor::New();
285 mDefaultCamera.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
286 mDefaultCamera.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
287 mDefaultCamera.SetNearClippingPlane(1.0f);
288 AddCamera(mDefaultCamera);
289 UpdateCamera(mDefaultCamera);
292 void SceneView::OnChildAdd(Actor& child)
294 if(child != mRootLayer)
296 mRootLayer.Add(child);
298 Control::OnChildAdd(child);
301 void SceneView::OnChildRemove(Actor& child)
303 mRootLayer.Remove(child);
304 Control::OnChildRemove(child);
307 float SceneView::GetHeightForWidth(float width)
310 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
311 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
314 float SceneView::GetWidthForHeight(float height)
317 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
318 return Control::GetWidthForHeight(height) + padding.start + padding.end;
321 void SceneView::OnRelayout(const Vector2& size, RelayoutContainer& container)
323 Control::OnRelayout(size, container);
324 // Change canvas size of camera actor.
328 bool SceneView::IsResourceReady() const
330 return mIBLResourceReady;
333 void SceneView::UpdateCamera(CameraActor camera)
337 if(mSelectedCamera && mSelectedCamera.GetParent())
339 mSelectedCamera.Unparent();
341 mRootLayer.Add(camera);
344 mSelectedCamera = camera;
348 void SceneView::UpdateRenderTask()
352 if(mSelectedCamera != mRenderTask.GetCameraActor())
354 mRenderTask.SetCameraActor(mSelectedCamera);
357 Vector3 size = Self().GetProperty<Vector3>(Dali::Actor::Property::SIZE);
358 const float aspectRatio = size.width / size.height;
359 mSelectedCamera.SetAspectRatio(aspectRatio);
360 const float halfHeight = mSelectedCamera[Dali::CameraActor::Property::TOP_PLANE_DISTANCE];
361 const float halfWidth = aspectRatio * halfHeight;
362 mSelectedCamera[Dali::CameraActor::Property::LEFT_PLANE_DISTANCE] = -halfWidth;
363 mSelectedCamera[Dali::CameraActor::Property::RIGHT_PLANE_DISTANCE] = halfWidth;
364 mSelectedCamera[Dali::CameraActor::Property::TOP_PLANE_DISTANCE] = halfHeight; // Top is +ve to keep consistency with orthographic values
365 mSelectedCamera[Dali::CameraActor::Property::BOTTOM_PLANE_DISTANCE] = -halfHeight; // Bottom is -ve to keep consistency with orthographic values
368 Dali::FrameBuffer currentFrameBuffer = mRenderTask.GetFrameBuffer();
369 if(!currentFrameBuffer ||
370 currentFrameBuffer.GetColorTexture().GetWidth() != size.width ||
371 currentFrameBuffer.GetColorTexture().GetHeight() != size.height)
373 mRenderTask.ResetViewportGuideActor();
374 mRenderTask.SetViewport(Dali::Viewport(Vector4::ZERO));
376 // create offscreen buffer of new size to render our child actors to
377 mTexture = Dali::Texture::New(TextureType::TEXTURE_2D, Pixel::RGBA8888, unsigned(size.width), unsigned(size.height));
378 mRenderTarget = FrameBuffer::New(size.width, size.height, FrameBuffer::Attachment::DEPTH_STENCIL);
379 mRenderTarget.AttachColorTexture(mTexture);
380 Dali::Toolkit::ImageUrl imageUrl = Dali::Toolkit::Image::GenerateUrl(mRenderTarget, 0u);
382 Property::Map imagePropertyMap;
383 imagePropertyMap.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
384 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::URL, imageUrl.GetUrl());
385 // To flip rendered scene without CameraActor::SetInvertYAxis() to avoid backface culling.
386 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, Vector4(0.0f, 1.0f, 1.0f, -1.0f));
387 mVisual = Toolkit::VisualFactory::Get().CreateVisual(imagePropertyMap);
389 Toolkit::DevelControl::RegisterVisual(*this, RENDERING_BUFFER, mVisual);
391 mRenderTask.SetFrameBuffer(mRenderTarget);
392 mRenderTask.SetClearEnabled(true);
393 mRenderTask.SetClearColor(Color::TRANSPARENT);
398 mRenderTask.SetViewportGuideActor(Self());
399 if(mRenderTask.GetFrameBuffer())
401 FrameBuffer framebuffer;
402 mRenderTask.SetFrameBuffer(framebuffer);
403 mRenderTask.SetClearEnabled(false);
409 } // namespace Internal
410 } // namespace Scene3D