X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fprimitive-visual-properties.h;h=9c62d79006dec117c449e152acccba911bcdcf9b;hb=cc7137614f4136f571ccecc22ad1b72c01f16156;hp=12f56e590a1150d62b779b0e7be92d0427f0ecf1;hpb=cb30ef68af0383b073ba2d425d3d95c1e916cbb4;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/visuals/primitive-visual-properties.h b/dali-toolkit/public-api/visuals/primitive-visual-properties.h index 12f56e5..9c62d79 100644 --- a/dali-toolkit/public-api/visuals/primitive-visual-properties.h +++ b/dali-toolkit/public-api/visuals/primitive-visual-properties.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_PRIMITIVE_VISUAL_PROPERTIES_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,10 +23,8 @@ namespace Dali { - namespace Toolkit { - /** * @addtogroup dali_toolkit_visuals * @{ @@ -38,16 +36,14 @@ namespace Toolkit */ namespace PrimitiveVisual { - /** - * @brief PrimitiveVisual Property + * @brief PrimitiveVisual Property. * @SINCE_1_1.45 */ namespace Property { - /** - * @brief PrimitiveVisual Property + * @brief Enumeration for the instance of properties belonging to the PrimitiveVisual. * @SINCE_1_1.45 */ enum @@ -73,12 +69,12 @@ enum /** * @brief The number of slices as you go around the shape. * @details Name "slices", type Property::INTEGER. - * For spheres and conical frustrums, this determines how many divisions there are as you go around the object. + * For spheres and conical frustums, this determines how many divisions there are as you go around the object. * @SINCE_1_1.45 * @note Optional. If not specified, the default is 128. * @note Applies to: * - Shape::SPHERE - * - Shape::CONICAL_FRUSTRUM + * - Shape::CONICAL_FRUSTUM * - Shape::CONE * - Shape::CYLINDER * @note The range is from 1 to 255. @@ -98,23 +94,23 @@ enum STACKS, /** - * @brief The scale of the radius of the top circle of a conical frustrum. + * @brief The scale of the radius of the top circle of a conical frustum. * @details Name "scaleTopRadius", type Property::FLOAT. * @SINCE_1_1.45 * @note Optional. If not specified, the default is 1.0f. * @note Applies to: - * - Shape::CONICAL_FRUSTRUM + * - Shape::CONICAL_FRUSTUM * @note Only values greater than or equal to 0.0f are accepted. */ SCALE_TOP_RADIUS, /** - * @brief The scale of the radius of the bottom circle of a conical frustrum. + * @brief The scale of the radius of the bottom circle of a conical frustum. * @details Name "scaleBottomRadius", type Property::FLOAT. * @SINCE_1_1.45 * @note Optional. If not specified, the default is 1.5f. * @note Applies to: - * - Shape::CONICAL_FRUSTRUM + * - Shape::CONICAL_FRUSTUM * - Shape::CONE * @note Only values greater than or equal to 0.0f are accepted. */ @@ -126,7 +122,7 @@ enum * @SINCE_1_1.45 * @note Optional. If not specified, the default is 3.0f. * @note Applies to: - * - Shape::CONICAL_FRUSTRUM + * - Shape::CONICAL_FRUSTUM * - Shape::CONE * - Shape::CYLINDER * @note Only values greater than or equal to 0.0f are accepted. @@ -200,22 +196,21 @@ enum */ namespace Shape { - /** * @brief The primitive shape to render as a PrimitiveVisual. * @SINCE_1_1.45 */ enum Type { - SPHERE, ///< A perfectly round geometrical object in three-dimensional space. @SINCE_1_1.45 - CONICAL_FRUSTRUM, ///< The area bound between two circles, i.e. a cone with the tip removed. @SINCE_1_1.45 - CONE, ///< Equivalent to a conical frustrum with top radius of zero. @SINCE_1_1.45 - CYLINDER, ///< Equivalent to a conical frustrum with equal radii for the top and bottom circles. @SINCE_1_1.45 - CUBE, ///< Equivalent to a bevelled cube with a bevel percentage of zero. @SINCE_1_1.45 - OCTAHEDRON, ///< Equivalent to a bevelled cube with a bevel percentage of one. @SINCE_1_1.45 - BEVELLED_CUBE, ///< A cube/cuboid with all edges flattened to some degree. @SINCE_1_1.45 + SPHERE, ///< A perfectly round geometrical object in three-dimensional space. @SINCE_1_1.45 + CONICAL_FRUSTUM, ///< The area bound between two circles, i.e. a cone with the tip removed. @SINCE_1_3.15 + CONE, ///< Equivalent to a conical frustum with top radius of zero. @SINCE_1_1.45 + CYLINDER, ///< Equivalent to a conical frustum with equal radii for the top and bottom circles. @SINCE_1_1.45 + CUBE, ///< Equivalent to a bevelled cube with a bevel percentage of zero. @SINCE_1_1.45 + OCTAHEDRON, ///< Equivalent to a bevelled cube with a bevel percentage of one. @SINCE_1_1.45 + BEVELLED_CUBE ///< A cube/cuboid with all edges flattened to some degree. @SINCE_1_1.45 }; -} +} // namespace Shape } // namespace PrimitiveVisual