X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fmodel3d-view%2Fmodel3d-view.h;h=3aa186d5aecd42df5925952a7bc5aaaa0d979175;hb=f4a28993f3f77f15015e5c9b4e1bedd06e23b926;hp=e1ad741f459321e5f96d5cd6def0bae78c9636b2;hpb=a073ebfd862b49692c8e6d7dff2b128e62a4f6df;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h index e1ad741..3aa186d 100644 --- a/dali-toolkit/public-api/controls/model3d-view/model3d-view.h +++ b/dali-toolkit/public-api/controls/model3d-view/model3d-view.h @@ -37,7 +37,7 @@ class Model3dView; * All the geometry loaded with the control is automatically centered and scaled to fit * the size of all the other controls. So the max is (0.5,0.5) and the min is (-0.5,-0.5) * - * @since DALi 1.1.4 + * @SINCE_1_1.4 */ class DALI_IMPORT_API Model3dView : public Control { @@ -45,32 +45,34 @@ public: /** * @brief The start and end property ranges for this control. + * @SINCE_1_1.4 */ enum PropertyRange { - PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices + PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.4 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_1.4 - ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, - ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices + ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.4 + ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_1.4 }; /** * @brief An enumeration of properties belonging to the TextLabel class. + * @SINCE_1_1.4 */ struct Property { enum { - GEOMETRY_URL = PROPERTY_START_INDEX, ///< name "geometryUrl", The path to the geometry file, type STRING - MATERIAL_URL, ///< name "materialUrl", The path to the material file, type STRING - IMAGES_URL, ///< name "imagesUrl", The path to the images directory, type STRING - ILLUMINATION_TYPE, ///< name "illuminationType", The type of illumination, type INTEGER - TEXTURE0_URL, ///< name "texture0Url", The path to first texture, type STRING - TEXTURE1_URL, ///< name "texture1Url", The path to second texture, type STRING - TEXTURE2_URL, ///< name "texture2Url", The path to third texture, type STRING - - LIGHT_POSITION = ANIMATABLE_PROPERTY_START_INDEX ///< name "lightPosition", The coordinates of the light, type Vector3 + GEOMETRY_URL = PROPERTY_START_INDEX, ///< name "geometryUrl", The path to the geometry file, type STRING @SINCE_1_1.4 + MATERIAL_URL, ///< name "materialUrl", The path to the material file, type STRING @SINCE_1_1.4 + IMAGES_URL, ///< name "imagesUrl", The path to the images directory, type STRING @SINCE_1_1.4 + ILLUMINATION_TYPE, ///< name "illuminationType", The type of illumination, type INTEGER @SINCE_1_1.4 + TEXTURE0_URL, ///< name "texture0Url", The path to first texture, type STRING @SINCE_1_1.4 + TEXTURE1_URL, ///< name "texture1Url", The path to second texture, type STRING @SINCE_1_1.4 + TEXTURE2_URL, ///< name "texture2Url", The path to third texture, type STRING @SINCE_1_1.4 + + LIGHT_POSITION = ANIMATABLE_PROPERTY_START_INDEX ///< name "lightPosition", The coordinates of the light, type Vector3 @SINCE_1_1.4 }; }; @@ -81,10 +83,10 @@ public: DIFFUSE_WITH_NORMAL_MAP }; - /** * @brief Create a new instance of a Model3dView control. * + * @SINCE_1_1.4 * @return A handle to the new Model3dView control. */ static Model3dView New(); @@ -92,6 +94,10 @@ public: /** * @brief Create a new instance of a Model3dView control. * + * @SINCE_1_1.4 + * @param[in] objUrl The path to the geometry file + * @param[in] mtlUrl The path to the material file + * @param[in] imagesUrl The path to the images directory * @return A handle to the new Model3dView control. */ static Model3dView New( const std::string& objUrl, const std::string& mtlUrl, const std::string& imagesUrl ); @@ -102,6 +108,7 @@ public: * * Only derived versions can be instantiated. Calling member * functions with an uninitialized Dali::Object is not allowed. + * @SINCE_1_1.4 */ Model3dView(); @@ -109,16 +116,22 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_1.4 */ ~Model3dView(); /** * @brief Copy constructor. + * @SINCE_1_1.4 + * @param[in] model3dView Handle to an object */ Model3dView( const Model3dView& model3dView ); /** * @brief Assignment operator. + * @SINCE_1_1.4 + * @param[in] model3dView Handle to an object + * @return reference to this */ Model3dView& operator=( const Model3dView& model3dView ); @@ -128,6 +141,7 @@ public: * If handle points to a Model3dView the downcast produces valid * handle. If not the returned handle is left uninitialized. * + * @SINCE_1_1.4 * @param[in] handle Handle to an object * @return handle to a Model3dView or an uninitialized handle */ @@ -135,9 +149,11 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * + * @SINCE_1_1.4 * @param[in] implementation The Control implementation. */ DALI_INTERNAL Model3dView( Internal::Model3dView& implementation ); @@ -145,9 +161,11 @@ public: // Not intended for application developers /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * + * @SINCE_1_1.4 * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL Model3dView( Dali::Internal::CustomActor* internal ); + /// @endcond };