1 #ifndef DALI_TOOLKIT_MODEL3D_VIEW_H
2 #define DALI_TOOLKIT_MODEL3D_VIEW_H
5 * Copyright (c) 2020 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-toolkit/public-api/controls/control.h>
28 namespace Internal DALI_INTERNAL
34 * @addtogroup dali_toolkit_controls_model3d_view
39 * @brief Model3dView is a control for displaying 3d geometry.
41 * All the geometry loaded with the control is automatically centered and scaled to fit
42 * the size of all the other controls. So the max is (0.5,0.5) and the min is (-0.5,-0.5).
46 class DALI_TOOLKIT_API Model3dView : public Control
50 * @brief Enumeration for the start and end property ranges for this control.
55 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.4
56 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_1.4
58 ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.4
59 ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_1.4
63 * @brief Enumeration for the instance of properties belonging to the TextLabel class.
69 * @brief Enumeration for the instance of properties belonging to the TextLabel class.
74 GEOMETRY_URL = PROPERTY_START_INDEX, ///< name "geometryUrl", The path to the geometry file, type STRING @SINCE_1_1.4
75 MATERIAL_URL, ///< name "materialUrl", The path to the material file, type STRING @SINCE_1_1.4
76 IMAGES_URL, ///< name "imagesUrl", The path to the images directory, type STRING @SINCE_1_1.4
77 ILLUMINATION_TYPE, ///< name "illuminationType", The type of illumination, type INTEGER @SINCE_1_1.4
78 TEXTURE0_URL, ///< name "texture0Url", The path to first texture, type STRING @SINCE_1_1.4
79 TEXTURE1_URL, ///< name "texture1Url", The path to second texture, type STRING @SINCE_1_1.4
80 TEXTURE2_URL, ///< name "texture2Url", The path to third texture, type STRING @SINCE_1_1.4
82 LIGHT_POSITION = ANIMATABLE_PROPERTY_START_INDEX ///< name "lightPosition", The coordinates of the light, type Vector3 @SINCE_1_1.4
87 * @brief Enumeration for the type of illumination.
92 DIFFUSE, ///< diffuse @SINCE_1_1.4
93 DIFFUSE_WITH_TEXTURE, ///< diffuse with texture @SINCE_1_1.4
94 DIFFUSE_WITH_NORMAL_MAP ///< diffuse with normal map @SINCE_1_1.4
98 * @brief Creates a new instance of a Model3dView control.
101 * @return A handle to the new Model3dView control
103 static Model3dView New();
106 * @brief Creates a new instance of a Model3dView control.
109 * @param[in] objUrl The path to the geometry file
110 * @param[in] mtlUrl The path to the material file
111 * @param[in] imagesUrl The path to the images directory
112 * @return A handle to the new Model3dView control
114 static Model3dView New(const std::string& objUrl, const std::string& mtlUrl, const std::string& imagesUrl);
117 * @brief Creates an uninitialized Model3dView.
119 * Only derived versions can be instantiated. Calling member
120 * functions with an uninitialized Dali::Object is not allowed.
128 * This is non-virtual since derived Handle types must not contain data or virtual methods.
134 * @brief Copy constructor.
136 * @param[in] model3dView Handle to an object
138 Model3dView(const Model3dView& model3dView);
141 * @brief Move constructor
144 * @param[in] rhs A reference to the moved handle
146 Model3dView(Model3dView&& rhs);
149 * @brief Assignment operator.
151 * @param[in] model3dView Handle to an object
152 * @return reference to this
154 Model3dView& operator=(const Model3dView& model3dView);
157 * @brief Move assignment
160 * @param[in] rhs A reference to the moved handle
161 * @return A reference to this
163 Model3dView& operator=(Model3dView&& rhs);
166 * @brief Downcasts an Object handle to Model3dView.
168 * If handle points to a Model3dView, the downcast produces valid handle.
169 * If not, the returned handle is left uninitialized.
172 * @param[in] handle Handle to an object
173 * @return Handle to a Model3dView or an uninitialized handle
175 static Model3dView DownCast(BaseHandle handle);
177 public: // Not intended for application developers
180 * @brief Creates a handle using the Toolkit::Internal implementation.
183 * @param[in] implementation The Control implementation
185 DALI_INTERNAL Model3dView(Internal::Model3dView& implementation);
188 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
191 * @param[in] internal A pointer to the internal CustomActor
193 DALI_INTERNAL Model3dView(Dali::Internal::CustomActor* internal);
200 } // namespace Toolkit
204 #endif // DALI_TOOLKIT_MODEL3D_VIEW_H