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()
123 return mCameras.size();
126 CameraActor SceneView::GetSelectedCamera()
128 return mSelectedCamera;
131 CameraActor SceneView::GetCamera(uint32_t index)
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)
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 Texture diffuseTexture = Dali::Scene3D::Loader::LoadCubeMap(diffuse);
194 Texture specularTexture = Dali::Scene3D::Loader::LoadCubeMap(specular);
197 mDiffuseTexture = diffuseTexture;
198 mSpecularTexture = specularTexture;
199 mIblScaleFactor = scaleFactor;
201 for(auto&& model : mModels)
205 model.SetImageBasedLightTexture(mDiffuseTexture, mSpecularTexture, mIblScaleFactor);
212 void SceneView::UseFramebuffer(bool useFramebuffer)
214 if(mUseFrameBuffer != useFramebuffer)
216 mUseFrameBuffer = useFramebuffer;
221 bool SceneView::IsUsingFramebuffer()
223 return mUseFrameBuffer;
226 ///////////////////////////////////////////////////////////
231 void SceneView::OnSceneConnection(int depth)
235 Control::OnSceneConnection(depth);
238 void SceneView::OnSceneDisconnection()
241 Control::OnSceneDisconnection();
244 void SceneView::OnInitialize()
247 mRootLayer = Layer::New();
248 mRootLayer.SetProperty(Layer::Property::BEHAVIOR, Layer::LAYER_3D);
249 mRootLayer.SetProperty(Layer::Property::DEPTH_TEST, true);
250 // The models in the SceneView should be have independent coordinate with DALi default coordinate.
251 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_POSITION, false);
252 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_ORIENTATION, false);
253 mRootLayer.SetProperty(Dali::Actor::Property::INHERIT_SCALE, false);
254 self.Add(mRootLayer);
256 RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
257 mRenderTask = taskList.CreateTask();
258 mRenderTask.SetSourceActor(mRootLayer);
259 mRenderTask.SetExclusive(true);
260 mRenderTask.SetInputEnabled(true);
261 mRenderTask.SetScreenToFrameBufferMappingActor(Self());
263 mDefaultCamera = Dali::CameraActor::New();
264 mDefaultCamera.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
265 mDefaultCamera.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
266 mDefaultCamera.SetNearClippingPlane(1.0f);
267 AddCamera(mDefaultCamera);
268 UpdateCamera(mDefaultCamera);
271 void SceneView::OnChildAdd(Actor& child)
273 if(child != mRootLayer)
275 mRootLayer.Add(child);
277 Control::OnChildAdd(child);
280 void SceneView::OnChildRemove(Actor& child)
282 mRootLayer.Remove(child);
283 Control::OnChildRemove(child);
286 float SceneView::GetHeightForWidth(float width)
289 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
290 return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
293 float SceneView::GetWidthForHeight(float height)
296 padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
297 return Control::GetWidthForHeight(height) + padding.start + padding.end;
300 void SceneView::OnRelayout(const Vector2& size, RelayoutContainer& container)
302 Control::OnRelayout(size, container);
303 // Change canvas size of camera actor.
307 void SceneView::UpdateCamera(CameraActor camera)
311 if(mSelectedCamera && mSelectedCamera.GetParent())
313 mSelectedCamera.Unparent();
315 mRootLayer.Add(camera);
318 mSelectedCamera = camera;
322 void SceneView::UpdateRenderTask()
326 if(mSelectedCamera != mRenderTask.GetCameraActor())
328 mRenderTask.SetCameraActor(mSelectedCamera);
331 Vector3 size = Self().GetProperty<Vector3>(Dali::Actor::Property::SIZE);
333 Vector3 cameraPosition(Vector3::ZERO);
334 float nearPlain = 1.0f;
335 float farPlain = 1.0f;
337 // Several properties such as fov, nearPlane, farPlane, and position should not be changed after SetPerspectiveProjection is called.
338 // In the 3D scene, the properties are not changed by the changes of canvas size.
339 fov = mSelectedCamera[Dali::CameraActor::Property::FIELD_OF_VIEW];
340 nearPlain = mSelectedCamera[Dali::CameraActor::Property::NEAR_PLANE_DISTANCE];
341 farPlain = mSelectedCamera[Dali::CameraActor::Property::FAR_PLANE_DISTANCE];
342 cameraPosition = Vector3(mSelectedCamera[Dali::Actor::Property::POSITION]);
344 mSelectedCamera.SetPerspectiveProjection(Dali::Size(size));
346 mSelectedCamera[Dali::CameraActor::Property::FIELD_OF_VIEW] = fov;
347 mSelectedCamera[Dali::CameraActor::Property::NEAR_PLANE_DISTANCE] = nearPlain;
348 mSelectedCamera[Dali::CameraActor::Property::FAR_PLANE_DISTANCE] = farPlain;
349 mSelectedCamera[Dali::Actor::Property::POSITION] = cameraPosition;
353 Dali::FrameBuffer currentFrameBuffer = mRenderTask.GetFrameBuffer();
354 if(!currentFrameBuffer ||
355 currentFrameBuffer.GetColorTexture().GetWidth() != size.width ||
356 currentFrameBuffer.GetColorTexture().GetHeight() != size.height)
358 mRenderTask.ResetViewportGuideActor();
359 mRenderTask.SetViewport(Dali::Viewport(Vector4::ZERO));
361 // create offscreen buffer of new size to render our child actors to
362 mTexture = Dali::Texture::New(TextureType::TEXTURE_2D, Pixel::RGBA8888, unsigned(size.width), unsigned(size.height));
363 mRenderTarget = FrameBuffer::New(size.width, size.height, FrameBuffer::Attachment::DEPTH_STENCIL);
364 mRenderTarget.AttachColorTexture(mTexture);
365 Dali::Toolkit::ImageUrl imageUrl = Dali::Toolkit::Image::GenerateUrl(mRenderTarget, 0u);
367 Property::Map imagePropertyMap;
368 imagePropertyMap.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
369 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::URL, imageUrl.GetUrl());
370 // To flip rendered scene without CameraActor::SetInvertYAxis() to avoid backface culling.
371 imagePropertyMap.Insert(Toolkit::ImageVisual::Property::PIXEL_AREA, Vector4(0.0f, 1.0f, 1.0f, -1.0f));
372 mVisual = Toolkit::VisualFactory::Get().CreateVisual(imagePropertyMap);
374 Toolkit::DevelControl::RegisterVisual(*this, RENDERING_BUFFER, mVisual);
376 mRenderTask.SetFrameBuffer(mRenderTarget);
377 mRenderTask.SetClearEnabled(true);
378 mRenderTask.SetClearColor(Color::TRANSPARENT);
383 mRenderTask.SetViewportGuideActor(Self());
384 if(mRenderTask.GetFrameBuffer())
386 FrameBuffer framebuffer;
387 mRenderTask.SetFrameBuffer(framebuffer);
388 mRenderTask.SetClearEnabled(false);
394 } // namespace Internal
395 } // namespace Scene3D