1 #ifndef __DALI_TOOLKIT_MODEL3D_VIEW_H__
2 #define __DALI_TOOLKIT_MODEL3D_VIEW_H__
5 * Copyright (c) 2015 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>
30 namespace Internal DALI_INTERNAL
35 * @brief Model3dView is a control for displaying 3d geometry.
37 * All the geometry loaded with the control is automatically centered and scaled to fit
38 * the size of all the other controls. So the max is (0.5,0.5) and the min is (-0.5,-0.5).
42 class DALI_IMPORT_API Model3dView : public Control
47 * @brief Enumeration for the start and end property ranges for this control.
52 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.4
53 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_1.4
55 ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.4
56 ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_1.4
60 * @brief Enumeration for the instance of properties belonging to the TextLabel class.
66 * @brief Enumeration for the instance of properties belonging to the TextLabel class.
71 GEOMETRY_URL = PROPERTY_START_INDEX, ///< name "geometryUrl", The path to the geometry file, type STRING @SINCE_1_1.4
72 MATERIAL_URL, ///< name "materialUrl", The path to the material file, type STRING @SINCE_1_1.4
73 IMAGES_URL, ///< name "imagesUrl", The path to the images directory, type STRING @SINCE_1_1.4
74 ILLUMINATION_TYPE, ///< name "illuminationType", The type of illumination, type INTEGER @SINCE_1_1.4
75 TEXTURE0_URL, ///< name "texture0Url", The path to first texture, type STRING @SINCE_1_1.4
76 TEXTURE1_URL, ///< name "texture1Url", The path to second texture, type STRING @SINCE_1_1.4
77 TEXTURE2_URL, ///< name "texture2Url", The path to third texture, type STRING @SINCE_1_1.4
79 LIGHT_POSITION = ANIMATABLE_PROPERTY_START_INDEX ///< name "lightPosition", The coordinates of the light, type Vector3 @SINCE_1_1.4
87 DIFFUSE_WITH_NORMAL_MAP
91 * @brief Creates a new instance of a Model3dView control.
94 * @return A handle to the new Model3dView control
96 static Model3dView New();
99 * @brief Creates a new instance of a Model3dView control.
102 * @param[in] objUrl The path to the geometry file
103 * @param[in] mtlUrl The path to the material file
104 * @param[in] imagesUrl The path to the images directory
105 * @return A handle to the new Model3dView control
107 static Model3dView New( const std::string& objUrl, const std::string& mtlUrl, const std::string& imagesUrl );
111 * @brief Creates an uninitialized Model3dView.
113 * Only derived versions can be instantiated. Calling member
114 * 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.
128 * @brief Copy constructor.
130 * @param[in] model3dView Handle to an object
132 Model3dView( const Model3dView& model3dView );
135 * @brief Assignment operator.
137 * @param[in] model3dView Handle to an object
138 * @return reference to this
140 Model3dView& operator=( const Model3dView& model3dView );
143 * @brief Downcasts an Object handle to Model3dView.
145 * If handle points to a Model3dView, the downcast produces valid handle.
146 * If not, the returned handle is left uninitialized.
149 * @param[in] handle Handle to an object
150 * @return Handle to a Model3dView or an uninitialized handle
152 static Model3dView DownCast( BaseHandle handle );
154 public: // Not intended for application developers
158 * @brief Creates a handle using the Toolkit::Internal implementation.
161 * @param[in] implementation The Control implementation
163 DALI_INTERNAL Model3dView( Internal::Model3dView& implementation );
166 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
169 * @param[in] internal A pointer to the internal CustomActor
171 DALI_INTERNAL Model3dView( Dali::Internal::CustomActor* internal );
176 } // namespace Toolkit
180 #endif // __DALI_TOOLKIT_MODEL3D_VIEW_H__