1 #ifndef DALI_SCENE3D_SCENE_VIEW_H
2 #define DALI_SCENE3D_SCENE_VIEW_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali-scene3d/public-api/api.h>
25 #include <dali-toolkit/public-api/controls/control.h>
26 #include <dali/public-api/actors/camera-actor.h>
27 #include <dali/public-api/common/dali-common.h>
33 namespace Internal DALI_INTERNAL
39 * @addtogroup dali_toolkit_controls_scene_view
44 * @brief SceneView is a Dali::Toolkit::Control to show multiple 3D objects in a single 3D scene.
45 * Each SceneView has its own 3D space, and 3D objects added to SceneView are positioned in the space.
46 * SceneView has a 3D root layer internally to trigger the depth test in the rendering process.
47 * When an Actor is added to the SceneView with Add() method,
48 * the Actor and its children are actually become child of the 3D layer automatically.
52 * Dali::Layer(Layer::LAYER_3D)
56 * The children of the 3D root layer will be rendered with the SceneView's own CameraActor.
58 * SceneView can have multiple CameraActor and one of them is used to render the multiple objects as a Scene.
59 * AddCamera(), RemoveCamera(), GetCamera(), and SelectCamera() are methods to manage CameraActors of the SceneView.
60 * Users can place multiple cameras in a scene, either to show the entire scene or to show individual objects.
61 * And the user can select the currently needed camera by using the SelectCamera() method.
63 * SceneView makes one built-in CameraActor by default.
64 * The default CameraActor has index 0 and is not removed by using RemoveCamera() method.
65 * Therefore, the minimum value returned by GetCameraCount() method is 1.
67 * If the size of SceneView is changed, Some properties of CameraActor that depend on the size can be changed too.
68 * The changing properties are as follows: projectionMode, aspectRatio, leftPlaneDistance, rightPlaneDistance, topPlaneDistance, and bottomPlaneDistance.
69 * Position, near/farPlaneDistance, and FieldOfView are maintained even if the size of the SceneView is changed.
70 * The FieldOfView of Dali::CameraActor is for vertical fov. The horizontal fov is internally updated according to the SceneView size.
72 * The same light source is set for all Models added to SceneView, if SceneView has light source.
73 * The SetImageBasedLightSource() method sets the same IBL to all Models added to the SceneView.
74 * If any Model already has an IBL, it is replaced with the SceneView's IBL.
76 * SceneView provides an option to use FBO for rendering result with UseFramebuffer() method.
77 * If it is false, SceneView is always drawn in the form of a rectangle on the default window surface directly.
78 * It improves performance, but the SceneView is always drawn on top of other 2D objects regardless of Actor tree order.
79 * And it will show wrong result in case the window's default CameraActor is transformed.
80 * So, it is recommended not to change window's CameraActor.
82 * If FBO is used, the rendering result of SceneView is drawn on the FBO and it is mapped on the plane of the SceneView.
83 * It decreases performance, but it is useful to show SceneView according to the rendering order with other Actors.
84 * And it can be used in case window's CameraActor is transformed.
86 * And since SceneView is a Control, it can be placed together with other 2D UI components in the DALi window.
90 * Dali::Scene3D::SceneView sceneView = Dali::Scene3D::SceneView::New();
91 * sceneView.SetProperty(Dali::Actor::Property::SIZE, Vector2(400, 400));
92 * mWindow.Add(sceneView);
94 * Dali::Scene3D::ModelView model = Dali::Scene3D::ModelView::New(...);
95 * sceneView.Add(model);
97 * CameraActor cameraActor = CameraActor::New();
98 * sceneView.AddCamera(cameraActor);
102 class DALI_SCENE3D_API SceneView : public Dali::Toolkit::Control
106 * @brief Create an initialized SceneView.
107 * @return A handle to a newly allocated Dali resource
109 static SceneView New();
112 * @brief Creates an uninitialized SceneView.
114 * Only derived versions can be instantiated. Calling member
115 * functions with an uninitialized Dali::Object is not allowed.
122 * This is non-virtual since derived Handle types must not contain data or virtual methods.
127 * @brief Copy constructor.
128 * @param[in] sceneView Handle to an object
130 SceneView(const SceneView& sceneView);
133 * @brief Move constructor
135 * @param[in] rhs A reference to the moved handle
137 SceneView(SceneView&& rhs);
140 * @brief Assignment operator.
141 * @param[in] sceneView Handle to an object
142 * @return reference to this
144 SceneView& operator=(const SceneView& sceneView);
147 * @brief Move assignment
149 * @param[in] rhs A reference to the moved handle
150 * @return A reference to this
152 SceneView& operator=(SceneView&& rhs);
155 * @brief Downcasts an Object handle to SceneView.
157 * If handle points to a SceneView, the downcast produces valid handle.
158 * If not, the returned handle is left uninitialized.
160 * @param[in] handle Handle to an object
161 * @return Handle to a SceneView or an uninitialized handle
163 static SceneView DownCast(BaseHandle handle);
166 * @brief Adds a CameraActor to the SceneView
167 * The CameraActor can be used as a selected camera to render the scene by using SelectCamera(uint32_t) or SelectCamera(std::string)
170 * AspectRatio property of CameraActor will be changed depending on the Size of this SceneView.
172 * For Perspective camera
173 * The FieldOfView of Dali::CameraActor is for vertical fov.
174 * When the size of the SceneView is changed, the vertical fov is maintained
175 * and the horizontal fov is automatically calculated according to the SceneView's aspect ratio.
177 * For Orthographic camera
178 * leftPlaneDistance, rightPlaneDistance, and bottomPlaneDistance properties are defined according to the topPlaneDistance and aspectRatio.
180 * @param[in] camera CameraActor added on this scene view.
182 void AddCamera(Dali::CameraActor camera);
185 * @brief Removes a CameraActor from this SceneView.
186 * @note If removed CameraActor is selected CameraActor,
187 * first camera in the list is set to selected CameraActor.
189 * @param[in] camera CameraActor to be removed from this SceneView
191 void RemoveCamera(CameraActor camera);
194 * @brief Retrieves the number of cameras.
196 * @return Number of cameras those currently the SceneView contains.
198 uint32_t GetCameraCount() const;
201 * @brief Retrieves selected CameraActor.
203 * @return CameraActor currently used in SceneView as a selected CameraActor
205 CameraActor GetSelectedCamera() const;
208 * @brief Retrieves a CameraActor of the index.
210 * @param[in] index Index of CameraActor to be retrieved.
212 * @return CameraActor of the index
214 CameraActor GetCamera(uint32_t index) const;
217 * @brief Retrieves a CameraActor of the name.
219 * @param[in] name string keyword of CameraActor to be retrieved.
221 * @return CameraActor that has the name as a Dali::Actor::Property::NAME
223 CameraActor GetCamera(const std::string& name) const;
226 * @brief Makes SceneView use a CameraActor of index as a selected camera.
228 * @param[in] index Index of CameraActor to be used as a selected camera.
230 void SelectCamera(uint32_t index);
233 * @brief Makes SceneView use a CameraActor of a name as a selected camera.
235 * @param[in] name string keyword of CameraActor to be used as a selected camera.
237 void SelectCamera(const std::string& name);
240 * @brief Sets Image Based Light Source to apply it on the all Models those added on this SceneView.
242 * @note If any Models already have IBL, they are batch-overridden with the SceneView's IBL.
243 * If SceneView has IBL, IBL of newly added Model is also overridden.
244 * To set indivisual IBL for each Model, the Model's IBL should be set after the SceneView's IBL.
246 * @param[in] diffuse cube map that can be used as a diffuse IBL source.
247 * @param[in] specular cube map that can be used as a specular IBL source.
248 * @param[in] scaleFactor scale factor that controls light source intensity in [0.0f, 1.0f]. Default value is 1.0f.
250 void SetImageBasedLightSource(const std::string& diffuse, const std::string& specular, float scaleFactor = 1.0f);
253 * @brief Sets Scale Factor of Image Based Light Source.
255 * @note If SetImageBasedLightSource() or SetImageBasedLightTexture() method is called after this method, scaleFactor is overriden.
256 * @note Default value is 1.0f.
258 * @param[in] scaleFactor scale factor that controls light source intensity in [0.0f, 1.0f].
260 void SetImageBasedLightScaleFactor(float scaleFactor);
263 * @brief Gets Scale Factor of Image Based Light Source.
264 * Default value is 1.0f.
266 * @return scale factor that controls light source intensity.
268 float GetImageBasedLightScaleFactor() const;
271 * @brief Sets whether to use FBO or not for the SceneView.
272 * If useFramebuffer is true, rendering result of SceneView is drawn on FBO and it is mapping on this SceneView plane.
273 * If useFramebuffer is false, each item in SceneView is rendered on window directly.
276 * @note If useFramebuffer is true, it could decrease performance but entire rendering order is satisfied.
277 * If useFramebuffer is false, performance is become better but SceneView is rendered on top of the other 2D Actors regardless tree order.
279 * @param[in] useFramebuffer True to use FBO for SceneView.
281 void UseFramebuffer(bool useFramebuffer);
284 * @brief Gets whether this SceneView uses Framebuffer or not.
286 * @return bool True if this SceneView uses Framebuffer.
288 bool IsUsingFramebuffer() const;
290 public: // Not intended for application developers
293 * @brief Creates a handle using the Toolkit::Internal implementation.
295 * @param[in] implementation The Control implementation
297 DALI_INTERNAL SceneView(Internal::SceneView& implementation);
300 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
302 * @param[in] internal A pointer to the internal CustomActor
304 DALI_INTERNAL SceneView(Dali::Internal::CustomActor* internal);
311 } // namespace Scene3D
315 #endif // DALI_SCENE3D_SCENE_VIEW_H