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.
91 * Dali::Scene3D::SceneView sceneView = Dali::Scene3D::SceneView::New();
92 * sceneView.SetProperty(Dali::Actor::Property::SIZE, Vector2(400, 400));
93 * mWindow.Add(sceneView);
95 * Dali::Scene3D::Model model = Dali::Scene3D::Model::New(...);
96 * sceneView.Add(model);
98 * CameraActor cameraActor = CameraActor::New();
99 * sceneView.AddCamera(cameraActor);
103 class DALI_SCENE3D_API SceneView : public Dali::Toolkit::Control
107 * @brief The skybox types
110 enum class SkyboxType
112 CUBEMAP, ///< Skybox in cubemap
113 EQUIRECTANGULAR ///< Skybox in equirectangular projection
117 * @brief Create an initialized SceneView.
120 * @return A handle to a newly allocated Dali resource
122 static SceneView New();
125 * @brief Creates an uninitialized SceneView.
127 * Only derived versions can be instantiated. Calling member
128 * functions with an uninitialized Dali::Object is not allowed.
137 * This is non-virtual since derived Handle types must not contain data or virtual methods.
144 * @brief Copy constructor.
147 * @param[in] sceneView Handle to an object
149 SceneView(const SceneView& sceneView);
152 * @brief Move constructor
155 * @param[in] rhs A reference to the moved handle
157 SceneView(SceneView&& rhs);
160 * @brief Assignment operator.
163 * @param[in] sceneView Handle to an object
164 * @return reference to this
166 SceneView& operator=(const SceneView& sceneView);
169 * @brief Move assignment
172 * @param[in] rhs A reference to the moved handle
173 * @return A reference to this
175 SceneView& operator=(SceneView&& rhs);
178 * @brief Downcasts an Object handle to SceneView.
180 * If handle points to a SceneView, the downcast produces valid handle.
181 * If not, the returned handle is left uninitialized.
184 * @param[in] handle Handle to an object
185 * @return Handle to a SceneView or an uninitialized handle
187 static SceneView DownCast(BaseHandle handle);
190 * @brief Adds a CameraActor to the SceneView
191 * The CameraActor can be used as a selected camera to render the scene by using SelectCamera(uint32_t) or SelectCamera(std::string)
195 * AspectRatio property of CameraActor will be changed depending on the Size of this SceneView.
197 * For Perspective camera
198 * The FieldOfView of Dali::CameraActor is for vertical fov.
199 * When the size of the SceneView is changed, the vertical fov is maintained
200 * and the horizontal fov is automatically calculated according to the SceneView's aspect ratio.
202 * For Orthographic camera
203 * leftPlaneDistance, rightPlaneDistance, and bottomPlaneDistance properties are defined according to the topPlaneDistance and aspectRatio.
205 * @param[in] camera CameraActor added on this scene view.
207 void AddCamera(Dali::CameraActor camera);
210 * @brief Removes a CameraActor from this SceneView.
213 * @note If removed CameraActor is selected CameraActor,
214 * first camera in the list is set to selected CameraActor.
216 * @param[in] camera CameraActor to be removed from this SceneView
218 void RemoveCamera(CameraActor camera);
221 * @brief Retrieves the number of cameras.
224 * @return Number of cameras those currently the SceneView contains.
226 uint32_t GetCameraCount() const;
229 * @brief Retrieves selected CameraActor.
232 * @return CameraActor currently used in SceneView as a selected CameraActor
234 CameraActor GetSelectedCamera() const;
237 * @brief Retrieves a CameraActor of the index.
240 * @param[in] index Index of CameraActor to be retrieved.
242 * @return CameraActor of the index
244 CameraActor GetCamera(uint32_t index) const;
247 * @brief Retrieves a CameraActor of the name.
250 * @param[in] name string keyword of CameraActor to be retrieved.
252 * @return CameraActor that has the name as a Dali::Actor::Property::NAME
254 CameraActor GetCamera(const std::string& name) const;
257 * @brief Makes SceneView use a CameraActor of index as a selected camera.
260 * @param[in] index Index of CameraActor to be used as a selected camera.
262 void SelectCamera(uint32_t index);
265 * @brief Makes SceneView use a CameraActor of a name as a selected camera.
268 * @param[in] name string keyword of CameraActor to be used as a selected camera.
270 void SelectCamera(const std::string& name);
273 * @brief Sets Image Based Light Source to apply it on the all Models those added on this SceneView.
276 * @note If any Models already have IBL, they are batch-overridden with the SceneView's IBL.
277 * If SceneView has IBL, IBL of newly added Model is also overridden.
278 * To set indivisual IBL for each Model, the Model's IBL should be set after the SceneView's IBL.
280 * @param[in] diffuseUrl cube map that can be used as a diffuse IBL source.
281 * @param[in] specularUrl cube map that can be used as a specular IBL source.
282 * @param[in] scaleFactor scale factor that controls light source intensity in [0.0f, 1.0f]. Default value is 1.0f.
284 void SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor = 1.0f);
287 * @brief Sets Scale Factor of Image Based Light Source.
290 * @note If SetImageBasedLightSource() or SetImageBasedLightTexture() method is called after this method, scaleFactor is overriden.
291 * @note Default value is 1.0f.
293 * @param[in] scaleFactor scale factor that controls light source intensity in [0.0f, 1.0f].
295 void SetImageBasedLightScaleFactor(float scaleFactor);
298 * @brief Gets Scale Factor of Image Based Light Source.
299 * Default value is 1.0f.
302 * @return scale factor that controls light source intensity.
304 float GetImageBasedLightScaleFactor() const;
307 * @brief Sets whether to use FBO or not for the SceneView.
308 * If useFramebuffer is true, rendering result of SceneView is drawn on FBO and it is mapping on this SceneView plane.
309 * If useFramebuffer is false, each item in SceneView is rendered on window directly.
313 * @note If useFramebuffer is true, it could decrease performance but entire rendering order is satisfied.
314 * If useFramebuffer is false, performance is become better but SceneView is rendered on top of the other 2D Actors regardless tree order.
316 * @param[in] useFramebuffer True to use FBO for SceneView.
318 void UseFramebuffer(bool useFramebuffer);
321 * @brief Gets whether this SceneView uses Framebuffer or not.
324 * @return bool True if this SceneView uses Framebuffer.
326 bool IsUsingFramebuffer() const;
329 * @brief Sets Skybox for this scene.
330 * Skybox texture is asynchronously loaded. When loading is finished, ResourceReady is emitted.
333 * @param[in] skyboxUrl image url for skybox.
334 * @param[in] skyboxType The skybox type (by default it is cubemap).
336 void SetSkybox(const std::string& skyboxUrl, SkyboxType skyboxType = SkyboxType::CUBEMAP);
339 * @brief Sets Skybox intensity.
340 * The skybox intensity is multiplied to the color of skybox texture.
341 * Default value is 1.0f.
344 * @note Intensity should be positive value.
345 * @param[in] intensity Intensity value to be multiplied to the cube map color
347 void SetSkyboxIntensity(float intensity);
350 * @brief Gets Skybox intensity.
351 * Default value is 1.0f.
354 * @return skybox intensity
356 float GetSkyboxIntensity() const;
359 * @brief Sets Orientation of Skybox.
362 * @param[in] orientation Quaternion for orientation of Skybox.
364 void SetSkyboxOrientation(const Quaternion& orientation);
367 * @brief Gets Skybox orientation.
370 * @return skybox orientation
372 Quaternion GetSkyboxOrientation() const;
374 public: // Not intended for application developers
377 * @brief Creates a handle using the Toolkit::Internal implementation.
379 * @param[in] implementation The Control implementation
381 DALI_INTERNAL SceneView(Internal::SceneView& implementation);
384 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
386 * @param[in] internal A pointer to the internal CustomActor
388 DALI_INTERNAL SceneView(Dali::Internal::CustomActor* internal);
395 } // namespace Scene3D
399 #endif // DALI_SCENE3D_SCENE_VIEW_H